Hi Richard,
I had to manage a similar project with a few hundred existing files. The
project did not have comments in a doxygen style. For documentation I used
three different cases:
1) I included some new files with new functions to the project. The file
and the modules had been documented in the doxygen style. The path had
been added to doxygens INPUT.
2) I included some new functions to existing files. The file header had
been modified. The file and the new modules had been documented in the
doxygen style. The existing modules that should not be part of the
documentation had been marked with \cond \endcond. The path had been added
to doxygens INPUT.
3) I had to modify just a few lines in an existing function located
somewhere in the project. The modifications had been marked with some
(file) unique comments (eg: Modification_001_Start, Modification_001_End)
. The path had to be included to doxygens EXAMPLE_PATH. I described the
modifications in a general input file and added the code snippet with
\dontinclude filename.c
\skipline Modification_001_Start
\until Modification_001_End
The third method needs some manual effort and the risk of missing
documentation is high but its got very low impact on the existing code.
Best Regards
Bernd
From: rrauch <rra...@itrgmbh.de>
To: doxygen-users@lists.sourceforge.net
Date: 14.06.2013 11:22
Subject: [Doxygen-users] What is the best way to make Documentation
partially?
Hi Everyone,
we have made a project for customizing an existing WEC7 Board Support
Package for usage at a customer specific hardware development.
Such a BSP is a very huge project, with a lot of subdirectories and files,
common and hardware specific.
Within this project we have created some additional drivers, files and
touched some of the existing files.
For documentation of our work we want to make doxygen documentation only
for
parts, we have created or changed.
What is the best way for doing this? (We do not want to touch/add any
doxygen related information to files, we have not worked on).
Could I add any information to our files to tell doxygen to add this file
to
documentation, but not to add other files, which do not have this
information?
I found "ENABLED_SECTIONS" but with this functionality I am able to
exclude
parts from documentation.
Any ideas?
Thanks Richard
--
View this message in context:
http://doxygen.10944.n7.nabble.com/What-is-the-best-way-to-make-Documentation-partially-tp6078.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
------------------------------------------------------------------------------
This SF.net email is sponsored by Windows:
Build for Windows Store.
http://p.sf.net/sfu/windows-dev2dev
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
