Skip to content

Restructure documentation #10

Open
ukoethe opened this Issue Jul 8, 2011 · 2 comments

2 participants

@ukoethe
Owner
ukoethe commented Jul 8, 2011

We should make more use of Doxygen's built-in grouping support (look how the ITK page http://www.itk.org/Doxygen/html/modules.html uses \defgroup and \ingroup, compare the source http://itk.org/gitweb?p=ITK.git;a=blob_plain;f=Documentation/Doxygen/Modules.dox;hb=HEAD)

Also, we should review if the post-processing (post.py and makeFunctionIndex.py) is still necessary or if doxygen meanwhile provides better ways of achieving this.

Of course, we should also fix all warnings in the Doxygen output.

Some entities don't seem to belong to any group and are just deocumented in their respective namespaces. This should be fixed.

@ukoethe
Owner
ukoethe commented Oct 13, 2011

People who are willing to participate in a documentation effort:

  • the MIP group
  • Gilles Rochefort
  • Alexandra Herzog
@tesch1
tesch1 commented Oct 26, 2011
  • me, feel free to delegate small (<1h) tasks to me.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Something went wrong with that request. Please try again.