Modify

Opened 9 years ago

Closed 6 years ago

#23 closed enhancement (fixed)

Use Doxygen-style comments

Reported by: uwe Owned by: somebody
Priority: minor Milestone: Cosmetic fixes
Component: coreboot 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 (0)

Change History (4)

comment:1 in reply to: ↑ description ; follow-up: Changed 9 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?

comment:2 in reply to: ↑ 1 Changed 9 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.

comment:3 Changed 7 years ago by uwe

  • Patch Status set to there is no patch
  • version v2 deleted

comment:4 Changed 6 years ago by stepan

  • Resolution set to fixed
  • Status changed from new to closed

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.

Add Comment

Modify Ticket

Action
as closed The owner will remain somebody.
The resolution will be deleted. Next status will be 'reopened'.
Author


E-mail address and user name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.