Hi,

it came up again in gerrit again.

Currently the osmocom style states doxygen style comments should be done in the 
.c file.
Doxygen are those comments:
/*! a brief description of the function
 * \param something      Some description of the use
 * \return 0 if ...
 */
Doxygen takes those comments and generates a html documentation of the code.

I would like to change it to have those in the headers files instead (when the 
function in included in a header file).
When using the doxygen comments only for doyxen, for sure, there isn't a 
difference between 
having it in .c or in .h files.

But when using IDEs or language servers, they usually only parses headers files 
and
the .c files of the current active project (e.g. osmo-sgsn),
but not the .c files of other projects (libosmocore).

On the downside I only see the problem of increasing the size of header files, 
but I don't see
an issue in here.

Any thoughts?

Best,
lynxis

Reply via email to