Use Doxygen-style comments

[uwe]

We should probably use Doxygen-style comments to document (at least) the core API/code of LinuxBIOS.

Simple example:

/**
 * Description of the function.
 *
 * @param First input parameter description
 * @param Second input parameter description
 * @return Return value description
 */
 function foo(int x, int y) {
     return 0;
 }

[stepan]

We should probably use Doxygen-style comments to document (at least) the core API/code of LinuxBIOS.

This documentation is automatically available at:

​http://qa.linuxbios.org/docs/doxygen.php

It does not cover the romcc compiled parts though. Should we bother?

[uwe]

Replying to stepan:

We should probably use Doxygen-style comments to document (at least) the core API/code of LinuxBIOS.

This documentation is automatically available at:

​http://qa.linuxbios.org/docs/doxygen.php

It does not cover the romcc compiled parts though. Should we bother?

No, probably not. But I was referring to actually documenting the code. I know that the doxygen output is already available, but as there's very few comments (and none which have doxygen-syntax) the doxygen output is only of limited use.

[stepan]

This is part of the documentation chapter of the coding guidelines. No changes to the ticket in a year, and it seems to be a place holder. Closing it for now.