coding-conventions
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revision | Next revisionBoth sides next revision | ||
| coding-conventions [2011/01/05 03:00] – More details on doxygen documentation. mikael.ohman | coding-conventions [2011/01/05 03:03] – I'm so bold that i removed the part about $Id$ as it's not done, it doesn't seem necessary and noone seems to add it anyway. mikael.ohman | ||
|---|---|---|---|
| Line 103: | Line 103: | ||
| Doxygen will inherit documentation from super classes, so do not add comments unless something specific needs to be said for the implementering routine. Be sure to document all variables and return value, even trivial ones, to avoid reporting errors when generating the documentation. | Doxygen will inherit documentation from super classes, so do not add comments unless something specific needs to be said for the implementering routine. Be sure to document all variables and return value, even trivial ones, to avoid reporting errors when generating the documentation. | ||
| - | |||
| - | ==== Source file layout ==== | ||
| - | |||
| - | Each source file, header or implementation file starts with a Subversion identification line and an author line, e.g.: | ||
| - | |||
| - | /* $Id$ */ | ||
| === Header file layout === | === Header file layout === | ||
| Line 114: | Line 108: | ||
| Each header file has the following layout: | Each header file has the following layout: | ||
| - | * Subversion identification line | ||
| * Copyright notice | * Copyright notice | ||
| * Inclusion protection macro | * Inclusion protection macro | ||
| * Headers file includes | * Headers file includes | ||
| * Forward declarations | * Forward declarations | ||
| - | * Actual class definition with DOC++ comments | + | * Actual class definition with doxygen |
| For a typical example see element.h. | For a typical example see element.h. | ||
| Line 125: | Line 118: | ||
| Each implementation file has the following layout: | Each implementation file has the following layout: | ||
| - | * Subversion identification line | ||
| * Copyright notice | * Copyright notice | ||
| * Header file includes | * Header file includes | ||
coding-conventions.txt · Last modified: 2017/11/24 16:45 by bp