Ticket #23 (new enhancement)

Opened 2 years ago

Last modified 9 months ago

Use Doxygen-style comments

Reported by: uwe Owned by: somebody
Priority: minor Milestone: Cosmetic fixes
Component: coreboot Version:
Keywords: Cc:
Dependencies: Patch Status: there is no patch

Description

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;
 }

Attachments

Change History

in reply to: ↑ description ; follow-up: ↓ 2   Changed 2 years ago by 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?

in reply to: ↑ 1   Changed 2 years ago by 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.

  Changed 9 months ago by uwe

  • patchstatus set to there is no patch
  • version v2 deleted

Add/Change #23 (Use Doxygen-style comments)

Author



Action
as new
 
Note: See TracTickets for help on using tickets.