[Openvas-devel] Change Request 19: Style

Jan-Oliver Wagner jan-oliver.wagner at intevation.de
Fri Dec 12 14:27:04 CET 2008


On Freitag, 12. Dezember 2008, Matthew Mundell wrote:
> 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.

Indeed. I don't have a too strong opinion here.
Especially since it is automizable to add a "brief" in case
we realize we need it urgently.

Best

	Jan

-- 
Dr. Jan-Oliver Wagner | ++49-541-335 08 30  |  http://www.intevation.de/
Intevation GmbH, Neuer Graben 17, 49074 Osnabrück | AG Osnabrück, HR B 18998
Geschäftsführer: Frank Koormann, Bernhard Reiter, Dr. Jan-Oliver Wagner


More information about the Openvas-devel mailing list