[hipl-dev] [Bug 592197] Re: Adding more comments to the new mobility code
- From: René Hummen <592197@xxxxxxxxxxxxxxxxxx>
- To: hipl-dev@xxxxxxxxxxxxx
- Date: Tue, 02 Nov 2010 10:15:11 -0000
** Branch unlinked: lp:hipl
--
Adding more comments to the new mobility code
https://bugs.launchpad.net/bugs/592197
You received this bug notification because you are a member of HIPL core
team, which is subscribed to HIPL.
Status in Host Identity Protocol for Linux: In Progress
Bug description:
>From Rene: can you please make sure that the update.h contains doxygen comments
along with the static functions in update.c. It would also be great to
have some more comments in update.c in the function bodies.
(Miika: I would actually prefer to move all doxygen comments to the c files
because that's what developers really read)
---
* Doxygen headers must be present for every
function and every parameter (including return) must be documente.
* Parameters
that are modified in the function must be marked in the doxygen header, too.
* Tabs and spaces are missing. Tab = 8 spaces
* The keyword const is used only 3! times. Const correctness is one of the
cornerstones for good coding. This definitely
needs to be enhanced
---
Two update.h functions are doxygened. The rest of the functions are removed
from the header because they weren't used by other files.
Other related posts:
