[Insight-users] DOxygen configuration
Neil Killeen
Neil . Killeen at atnf . csiro . au
Thu, 29 May 2003 11:26:46 +1000 (EST)
On Wed, 28 May 2003, Luis Ibanez wrote:
>
> 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 :-)
>
i guess i wasn't clear on this. It's not
the link name, but the link file I am worrying about.
Thus, the doxygen output main file, index.html, contains
<a href="index.html" class="qindex">Main Page</a>
<a href="modules.html" class="qindex">Groups</a>
<a href="namespaces.html" class="qindex">Namespace List</a>
<a href="hierarchy.html" class="qindex">Class Hierarchy</a>
<a href="classes.html" class="qindex">Alphabetical List</a>
<a href="annotated.html" class="qindex">Compound List</a>
<a href="files.html" class="qindex">File List</a>
<a href="namespacemembers.html" class="qindex">Namespace Members</a>
<a href="functions.html" class="qindex">Compound Members</a>
<a href="globals.html" class="qindex">File Members</a>
Now this list comes from the file DoxygenHeader.html,
which, for our system, I based on the ITK version.
Of these files, modules.html and hierarchy.html did not get
created by Doxygen. I was trying to figure out if there is some switch
in the Doxygen configuration file I need to activate or not
since I would like to see these pages as well.
>
> 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.
>
will do. it was not clear to me whether modules.html etc
would get created if I had not created the equivalent
of your Modules.dox etc files.
I will continue my exciting reading of the Doxygen manual !
>
> ---
>
> 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...
>
our developers are creating classes and
applications all in the same environment. So I need
a way to document the applications as well.
I'll try to do it with DOxygen so that we have just
one system for code interface purposes (regardless
of whether that interface is a class or an application [command
line or GUI]). Doxygen apperas rather flexible so
that I should be able to embed images etc in
the documentation pages for applications (e.g.
images of the GUI interfaces)
cheers
Neil
>
>
> 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
> >
> >
> >
> >
>
>
>