[Doxygen-users] [Q]: How to resolve naming conflicts and document several projects in a single doxy
Brought to you by:
dimitri
|
From: Ricky M. <ric...@co...> - 2006-02-15 08:23:30
|
Hello,
I would like to generate a single documentation unit (Windows Help
file or HTML index file that will link all together) for a bunch
of projects contained in a single workspace. (read below).
The scenario:
~~~~~~~~~~
- My project space has a bunch of stand-alone projects that may use
also a shared library.
- Some of the projects contain files with the same names and even
some similar code (Same Namespace or class names) but belonging=20
to mutually exclusive projects.
- I use Kings Tools as a front end for running Doxygen from
Visual Studio 2003, which does the job in running doxygen as a
single documentation unit. The way this add-in runs, first it
collects a list of all the files in all the projects for creating
a temporary doxygen configuration file and then runs doxygen
generating the documentation under a 'Doc' directory.
Questions:
~~~~~~~~
1) How can I resolve the naming conflicts? (file names, class names)
... the solution I had in the past is the use of the \file tag with
part of the
file name as optional parameter.. but this not easy to maintain.
2) I would like to "group" the documentation that belongs to a project
together
as a "section", but I'm not sure how to do it. The Doxygen
documentation
mentions several "grouping" mechanisms, but I never really required
them
till today..
- How I configure the main generated page to contain links to the
different
project sections.=20
- What to put in every file/class for associating the file or code
to a specific
project sections.
I already use some grouping sections to document a bunch of
functions
that belongs to a common interface. using the \name tag and //@{ ..
//@}
keys.
Any hint?
Thanks in advance
--- Ricky Marek.=20
(Sorry for the long subject line)
********************** Legal Disclaimer ****************************
"This email may contain confidential and privileged material for the sole u=
se of the intended recipient. Any unauthorized review, use or distribution=
by others is strictly prohibited. If you have received the message in err=
or, please advise the sender by reply email and delete the message. Thank y=
ou."
**********************************************************************
|