Skip to content

#134 Global Doxygen Documentation

Metadata

Property Value
Reported by Christian Engwer (christi@conan.iwr.uni-heidelberg.de)
Reported at May 26, 2006 10:14
Type Bug Report
Version Git (pre2.4) [autotools]
Operating System Unspecified / All
Last edited by Christian Engwer (christi@conan.iwr.uni-heidelberg.de)
Last edited at Jan 4, 2008 00:25
Closed by Christian Engwer (christi@conan.iwr.uni-heidelberg.de)
Closed at Jan 4, 2008 00:25
Closed in version 1.1
Resolution Implemented
Comment

Description

dune-web should include a doxygen documentation of the whole Dune. Therefore dune-web must be extended:

  • We need Doxyfile in the appropriate directory. This Doxyfile should not include the source directories, but should instead have an include statement for a file containing the list of source directories.
  • The list of source directories should automatically be constructed during the configure target of dunecontrol. As dune-web is not under the control of autoconf, we will have to overwrite the configure method in the dune-web dune-module file (see dune-common/dune-module for an example).
  • Doxygen should not include all source files found in the modules. Source code found in the doc tree, for example, should be excluded. Perhaps it would be the best to add an entry ``Doxygen:'' to the dune.module file with a space sperated list of the files/directories to be included in the doxygen documentation.