THIS IS AN AUTOMATED MESSAGE, DO NOT REPLY.

A new Flyspray task has been opened.  Details are below. 

User who did this - Thomas Fetzer (Thomas Fetzer) 

Attached to Project - DuMuX
Summary - Improve Doxygen documentation
Task Type - Bug Report
Category - Documentation
Status - New
Assigned To - Alexander Kissinger, Lena Walter, Thomas Fetzer
Operating System - Unspecified
Severity - Low
Priority - Normal
Reported Version - SVN
Due in Version - 2.5
Due Date - Undecided
Details - Preparing the doxygen documentation for the 2.4 release we noticed 
some points, which could be improved for the next release.

1) Comment all public functions.
2) Update misleading/ wrong description functions. (e.g. intrinsic permeability 
in spatialparameters). 
2) Doxygen groups still named \"*Box*\" (skip or replace by \"Implicit\").

Therefore we thought about creating one model description (e.g. the 1p files), 
where one can see how to document the code. The use of \\tparam, \\param and 
\\return can be also discussed in this scope.

This task shall be used for announcing possible improvements for the doxygen 
documentation, so that we could discuss in the next meeting.

More information can be found at the following URL:
http://www.dumux.org/flyspray/index.php?do=details&task_id=209

You are receiving this message because you have requested it from the Flyspray 
bugtracking system.  If you did not expect this message or don't want to 
receive mails in future, you can change your notification settings at the URL 
shown above.
_______________________________________________
Dumux mailing list
[email protected]
https://listserv.uni-stuttgart.de/mailman/listinfo/dumux

Reply via email to