[Insight-users] DOxygen configuration

[Luis Ibanez]

Hi Neil,

Doxygen uses by default the word "Modules"
in the link for "modules.html".  We modified
Doxygen's code in order to display "Groups"

   The joy of open source software   :-)

You will find in Doxygen's code a section where
they manage multi-lingual implementation. There
is a list of 'words' there. It will be great if
Doxygen put this in configuration files instead
of code...


In order to generate the groups we have a
file "Modules.dox" in the directory

   Insight/Documentation/Doxygen

Where you define all the class groups.
The you must go to your classes and classify
them in to the groups you defined in the
Modules.dox file.  For this you use the
Doxygen keyword:  \ingroup

Look at any of the ITK headers and see how
the keyworkd is used.


---

For InsightApplications, we don't set link to
the applications from the documentation of the
toolkit. We do this from the main ITK home page.
You could probably manage to do this by manipulating
the DoxygenHeader.html file.

However, I'm not sure that this is a good thing
to do, since when you look for the doc of the
toolkit you are rarely interested in the applications.
A link from a main web pagge may make more sense...



Regards,


   Luis


--------------------------------------------


Neil Killeen wrote:
> Luis
> 
> a couple more Doxygen related queries
> 
> I have set up our development platform to use Doxygen to generate
> the class documentation in much the same way as itk/vtk
> 
> 
> Question 1
> -----------
> 
> One thing I have not figured out is as follows.
> The home Doxygen generated page for ITK has  links
> 
> Main Page
> Groups
> Namespace List
> Class Hierarchy
> Alphabetical List
> Compound List
> File List
> Namespace Members
> Compound Members
> File Members
> Concepts
> 
> 
> I know that these links are provided for in the file
> DOcumentation/Doxygen/DoxygenHeader.html
> 
> However, I haven't worked out how you got Doxygen
> to generate, say the 'Groups' file (it is called modules.html).
> 
> I realize DOxygen runs via the provided configuration
> file which for ITK is created by parsing
> 
> Utilities/Doxygen/doxygen.config.in  (see previous email).
> 
> I see there are these ancilliary files *.pl and *.pl.in
> but I cannot see how you have asked Doxygen to
> 
>   . create modules.html (and others)
>   . populate it with the text and links to the appropriate classes.
> 
> Could you explain that to me ?  I'd like to do it for our system to.
> No doubt it is all to do with tags and parsing and filtering  :-/
> 
> 
> Question 2
> -----------
> 
> I was also thinking that for our system, which has end-user
> applications, like the ones you now have in the InsightApplications
> tree, it would be good to document these also with Doxygen.
> 
> Thus I would endeavour arrange our main Doxygen generated page to have
> links to 'Applications' as well as to the class documentation.
> 
> Have you thought about doing this for ITK - i was wondering
> if you have already thought about the necessary tags
> for things like command-line arguments to applications etc.
> 
> 
> 
> 
> 
> regards
> Neil
> 
> 
> 
>