[PATCH] confdefs: Add declaration for unlimited objects.

Joel Sherrill Joel.Sherrill at OARcorp.com
Wed Mar 28 08:55:17 CDT 2012


But confdefs.h does define things. In many cases, an  ifndef is followed by a define 
to a default value. Those are the cases to document. If I encouraged Gedare to
Doxygen something else (instead of just a good comment), then that was a mistake.

Certainly everything in there isn't documented but some is:

http://www.rtems.org/onlinedocs/doxygen/cpukit/html/confdefs_8h.html#acb6d25ad3c80a72ef6e3b461540b099b

--joel
________________________________________
From: rtems-devel-bounces at rtems.org [rtems-devel-bounces at rtems.org] On Behalf Of Sebastian Huber [sebastian.huber at embedded-brains.de]
Sent: Wednesday, March 28, 2012 2:04 AM
To: rtems-devel at rtems.org
Subject: Re: [PATCH] confdefs: Add declaration for unlimited objects.

On 03/28/2012 01:33 AM, Joel Sherrill wrote:
> I thought confdefs.h was mostly if not all Doxygen comments now. If so, the new element should have Doxygen markup

Doxygen documentation in this file makes no sense, since you can only document
things which are defined.  To document the configuration defines we would have
to add a new file which defines every switch and add comments to them.

--
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.
_______________________________________________
rtems-devel mailing list
rtems-devel at rtems.org
http://www.rtems.org/mailman/listinfo/rtems-devel


More information about the rtems-devel mailing list