Google Code In Patches

[Gedare Bloom]

Thanks Cynthia. For the purposes of keeping the GCI tasks rolling, I
am committing these when they are passed. Many small issues are sure
to crop up, with formatting and minor Doxygen processing issues. We
can address them as we spot them, I hope.

The instructions are on the wiki and anyone can update them. I don't
have the time now, maybe tomorrow I might get to look.

If these patches are introducing new things to fix, for example the
discussion about Titles versus paragraph headings, then we can create
new GCI tasks to get the work done.

Feel free to revert any of the patches if they are really bad. I am
trying to at least look through to make sure they seem OK, though I
saw I missed a couple of problems with the first libcsupport patch.

Thanks
-Gedare

On Sun, Dec 9, 2012 at 5:08 PM, Cynthia Rempel
<cynt6007 at vandals.uidaho.edu> wrote:
> Hi,
>
> Google Code In is a project designed to encourage high-schoolers to code.
>
> 1. Unfortunately, the directions for the Doxygen commenting are now so complicated, that high-schoolers would have a hard time understanding them; I'M having problems understanding them and I have a Master's in Computer Science.
>
> 2. Every time anyone submits a Google Code In patch it receives harsh criticism, which defeats the purpose of encouraging young people to code.
>
> 3. The purpose for Doxygen comments is different than regular comments: they are used to generate documentation, not make the code more clear. Documentation is often used in safety, and suitability certification processes.
>
> That being said, I simply ask that the directions be simplified.
>
> A positive step for criticism would be simple directions on how to get the comments on the source code to generate documentation that will pass safety and suitability certifications.
>
> C Rempel
> ________________________________________
> 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: Sunday, December 09, 2012 1:07 PM
> To: Joel Sherrill
> Cc: rtems-devel at rtems.org
> Subject: Re: [PATCH] libcsupport: Clean up Doxygen Task #1
>
> On 09/12/12 21:46, Joel Sherrill wrote:
>> I don't have the url handy but that description is less than 100% correct. Check at least the files list in our generated html. It is a TOC.
>
> The file and class lists are something different. I am talking about the
> @brief of functions.  Here paragraphs are used. You can see this also in
> the output since Doxygen automatically adds a period.
>
> --
> 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
>
>
> _______________________________________________
> rtems-devel mailing list
> rtems-devel at rtems.org
> http://www.rtems.org/mailman/listinfo/rtems-devel