Ticket #467 (new task)

Opened 3 years ago

Last modified 3 years ago

Use doxygen comments in all headerfiles

Reported by: sjors Owned by:
Priority: blocker Milestone: kmess-3.0
Component: Documentation Version: 2.0-beta1
Keywords: Cc:

Description

At this moment, the header files for all classes contain documentation like this:

    // this method prints foo
    void       printFoo();

Doxygen ignores comments like that, instead, we should write this:

    //! this method prints foo
    void       printFoo();

So we should run a s_//_//!_ on our headerfiles as one of the first things we do for kmess 2.1. This will probably also highlight a lot of classes with missing documentation... :)

Change History

Changed 3 years ago by sjors

  • type changed from defect to task

argh, I fail at filling in forms when tired

Note: See TracTickets for help on using tickets.