Documentation #200

Doxygen comments for all classes

Added by wuttke over 7 years ago. Updated almost 7 years ago.

Status:RejectedStart date:09 Mar 2013
Priority:LowDue date:
Assignee:-% Done:

0%

Category:-
Target version:-

Description

Write missing doxygen comments for classes, method, member variables.
Unify the wording.
Follow conventions of Qt.

Everybody should contribute to this whenever reading code.

History

#1 Updated by celine over 7 years ago

  • Assignee set to celine

#2 Updated by herck over 7 years ago

  • Target version set to Sprint 12

#3 Updated by wuttke over 7 years ago

  • Assignee changed from celine to wuttke

#4 Updated by wuttke over 7 years ago

  • Status changed from New to In Progress

#5 Updated by herck over 7 years ago

  • Target version changed from Sprint 12 to Sprint 13

#6 Updated by wuttke over 7 years ago

  • Description updated (diff)
  • Assignee deleted (wuttke)
  • Priority changed from Normal to Low
  • Target version deleted (Sprint 13)

#7 Updated by pospelov almost 7 years ago

  • Status changed from In Progress to Rejected

In the frame of the last doxygen UserAPI activity I have placed comments to all files and all classes (@class). But not in the class methods, of course.

I suggest to remove this issue, since it's long playing "coding principles" and not something one can do during the sprint.

In the future, I suggest from time to time revise doxygen's UserAPI and propagate revisions into corresponding class comments.

Also available in: Atom PDF