feurig/libmaplemidi-cma/support/doxygen, branch master

Doxygen hacks and fixups.

2012-06-28T21:29:43+00:00

- Shut Doxygen up in various places - Fix some genuine docs bugs - Ignore sources we're not responsible for Signed-off-by: Marti Bolivar

Doxyfile: Add to PREDEFINED to cover libmaple_types.h.

2012-05-31T21:24:17+00:00

Signed-off-by: Marti Bolivar

Doxygen: add the Evil Mangler.

2012-05-10T19:48:48+00:00

Whenever Doxygen is running on a series header, make it run an awk script, the Evil Mangler, that pretends the file is enclosed in an appropriate namespace declaration for the series target. Doxygen chokes if two structs have the same name. This is a problem for the series headers, which commonly have data structures with the same name. However, if those structs are in different namespaces, Doxygen has no problems. We obviously can't use namespaces in C headers, so use FILTER_PATTERNS to trick Doxygen into thinking they're there. Ugly, but I can't think of a better way to handle this. Signed-off-by: Marti Bolivar

Doxyfile: Disable TYPEDEF_HIDES_STRUCT to work around Breathe issues.

2012-05-10T17:20:03+00:00

This works around a problem we're having getting the XML for the series headers into a form that we can work with in leaflabs-docs. Signed-off-by: Marti Bolivar

Change __DOXYGEN_PREDEFINED_HACK to DOXYGEN.

2012-05-09T19:09:52+00:00

avr-gcc does it this way. Seems ok to me. Signed-off-by: Marti Bolivar

Shut up, doxygen.

2012-05-09T19:00:45+00:00

Signed-off-by: Marti Bolivar

Doxyfile: Allow group documentation.

2012-05-03T18:09:05+00:00

This change allows us to document several members of a group with one Doxygen comment. It's not clear how well this will work out in practice. Signed-off-by: Marti Bolivar

Doxyfile: add __DOXYGEN_PREDEFINED_HACK to PREDEFINED.

2011-08-23T03:29:59+00:00

Doxygen refuses to trust us when we \def something that it doesn't notice as a #define. To work around this, we put __DOXYGEN_PREDEFINED_HACK into our Doxyfile's PREDEFINED, so that documentation may be inserted for #defines which we know will exist.

Fix Doxyfile.

2011-08-04T00:14:09+00:00

Remove reST documentation, attendant updates.

2011-06-12T00:05:33+00:00

The documentation covers topics not specifically relevant to libmaple, so it doesn't make sense for it to be part of the libmaple source distribution. Delete the docs/ tree, and prepare libmaple for use with the new leaflabs-docs repo, which will contain the docs from now on. * README: update to reflect this change * support/doxygen/Doxyfile: This is the old docs/Doxyfile * Makefile: Add a doxygen target * wirish/comm/HardwareSerial.h: fix reference to docs/. The comment informing maintainers that the HardwareSerial interface is documented by hand refers to the docs/ tree, which no longer exists. Update it to refer to the separate leaflabs-docs repository. * support/scripts/copy-to-ide: No longer build the documentation