[PATCH] libcsupport: Clean up Doxygen Task #1

Sebastian Huber sebastian.huber at embedded-brains.de
Sun Dec 9 16:38:05 UTC 2012


On 09/12/12 16:11, Joel Sherrill wrote:
> Sorry for not doing this inline but that's what my tablet client does.
>
> @brief text really should be in what is called Title Case in the States. They are used like table of content entries and should not have periods.

The @brief are not used for table of content stuff.  Please have a look at

http://www.stack.nl/~dimitri/doxygen/commands.html#cmdbrief

Here you have "Starts a paragraph that serves as a brief description." .

>
> The missing marker is a mistake in the instructions and something no one thought about.

Which missing marker?

-- 
Sebastian Huber, embedded brains GmbH

Address : Obere Lagerstr. 30, D-82178 Puchheim, Germany
Phone   : +49 89 18 90 80 79-6
Fax     : +49 89 18 90 80 79-9
E-Mail  : sebastian.huber at embedded-brains.de
PGP     : Public key available on request.

Diese Nachricht ist keine geschäftliche Mitteilung im Sinne des EHUG.




More information about the devel mailing list