← Back to team overview

kicad-developers team mailing list archive

Doxygen comment style



the current coding standard says that function comments should look like

 * Function foo
 * blablabla

Since doxygen uses the first line as the brief description, the class
overview ends up looking like this:

| foo | Function foo |
| bar | Function bar |

That is not really helpful, in my opinion, so I've violated the policy
in a few places already, and seem to have gotten away with it.

Can we change the policy as well though?

  The first sentence should briefly describe the function. It should
  fit into a single line and be written in the infinitive form, without
  a subject, e.g. "Get the width of the outline" or "Re-run DRC". The
  brief description should be understandable on its own, as it is used
  in the class index.


Attachment: signature.asc
Description: OpenPGP digital signature

Follow ups