[Openvas-devel] Change Request 19: Style

[Matthew Mundell]

> > Secondly, how about turning on Doxygen JAVADOC_AUTOBRIEF?  This allows
> > forms such as
> >
> > 	/** Free any server rules. */
> > 	void
> > 	maybe_free_server_rules ()
> > 	...
> >
> > in place of
> >
> > 	/**
> > 	 * @brief Free any server rules.
> > 	 */
> > 	void
> > 	maybe_free_server_rules ()
> > 	...
>
> the latter form clearly says we use doc method to a novice developer.
> From the first version you don't really know.

Very considerate, although the double star should give the novice some
clue.

Most functions have arguments and/or a return, like

	/** "Strip" spaces from either end of a string.
	  *
	  * @param[in,out]  string  The string to strip.
	  * @param[in]      end     Pointer to the end of the string.
	  *
	  * \return A new pointer into the string.
	  */
	char*
	strip_space (char* string, char* end)
	{

which shows the doc method even with autobrief.

> I always prefer self-explaining approaches. Probably because I am too
> lazy to read manuals before digging into something ;-)