[1/1] cpukit/libblock Doxygen Enhancement Task #1

[Sebastian Huber]

On 21/12/12 15:30, Joel Sherrill wrote:
> Just to make sure... is this desire documented in:
>
> http://www.rtems.org/wiki/index.php/GoogleCodeInProjects#Cleanup_Doxygen
>
> Even if it has to be repeated from an earlier task description?
>

Yes, Gedare updated this page accordingly:

Use sentences for function @brief

Convert function @brief from "Table of Contents" to "Topic sentence" 
style. The descriptive text of a function's @brief is used to start a 
paragraph, so it should be a simple, concise sentence describing the 
function that begins with an active, present tense verb. See 
Doxygen_Recommendations#Declaring_functions 
<http://www.rtems.org/wiki/index.php/Doxygen_Recommendations#Declaring_functions> 
for an example. When the description begins with a noun, rewrite the 
description so that the action of the function comes first. Eliminate 
any redundant wording such as "Function that does..." or "This 
function...".

-- 
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.