Project

General

Profile

Actions

Bug #372

open

Doxygen API-Documentation incomplete/erroneous

Added by Jörg Riesmeier over 17 years ago. Updated over 2 years ago.

Status:
Assigned
Priority:
Normal
Assignee:
-
Category:
Documentation
Target version:
-
Start date:
Due date:
% Done:

0%

Estimated time:
Module:
various
Operating System:
Compiler:

Description

Just look at the file "doxygen/htmldocs.log", all the errors are there. The erroneously documented parameters should at least be corrected by the next release - and the parameters for methods/functions too, which are otherwise well documented.

=== Update Eichelberg (2009-08-05) ===
Even after filtering out unimportant warnings, there are still almost 3000 left!

=== JR's comment ===

That may be so, but the problems won't solve themselves. The warnings stem from one reason: namely undocumented or "falsely" documented portions. If everyone would take their own "favourite" module respectively, or ones on which they have worked on the most, then we should make considerable progress...

Actions #1

Updated by Andrew Chiw over 12 years ago

Doxygen API-Documentation incomplete/erroneous
Description

Just look at the file "doxygen/htmldocs.log", all the errors are there. The erroneously documented parameters should at least be corrected by the next release - and the parameters for methods/functions too, which are otherwise well documented.

=== Update Eichelberg (2009-08-05) ===
Even after filtering out unimportant warnings, there are still almost 3000 left!

=== JR's comment ===

That may be so, but the problems won't solve themselves. The warnings stem from one reason: namely undocumented or "falsely" documented portions. If everyone would take their own "favourite" module respectively, or ones on which they have worked on the most, then we should make considerable progress...

Actions #2

Updated by Andrew Chiw over 12 years ago

  • Subject changed from Doxygen API-Dokumentation teilweise unvollstaendig/fehlerhaft to Doxygen API-Documentation incomplete/erroneous
Actions #3

Updated by Jörg Riesmeier almost 9 years ago

  • Category set to Documentation
  • Target version set to 3.6.2
  • Module changed from diverse to various
Actions #4

Updated by Marco Eichelberg over 8 years ago

  • Priority changed from High to Normal
  • Target version changed from 3.6.2 to 3.6.3
Actions #5

Updated by Marco Eichelberg almost 8 years ago

  • Target version changed from 3.6.3 to 3.6.6
Actions #6

Updated by Pedro Fernando Arizpe Gómez over 6 years ago

  • Status changed from New to Assigned
  • Assignee set to Anonymous
Actions #7

Updated by Michael Onken over 5 years ago

  • Target version deleted (3.6.6)
Actions #8

Updated by Jörg Riesmeier over 2 years ago

  • Assignee deleted (Anonymous)
Actions

Also available in: Atom PDF