rrauch wrote:
> 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?
I've not tried anything like you describe, but what little I've
done with ENABLED_SECTIONS suggests to me that it won't help
much. Yes it can exclude parts of documentation, but only by
altering that code to surround it by section markers that you
can then NOT define in ENABLED_SECTIONS. That doesn't really
sound like a good fit to me.
Others with more experience may be able to offer alternatives
but I see two possibilities at the moment:
1. Keep the INPUT defined to a specific list of files
(just those you have changed)
or
2. Create a small program to attach to INPUT_FILTER.
This program could operate in one of two ways:
- simply reflect (output directly) files with a
timestamp beyond when you started work but
exclude all others
- parse the file to find a marker you put in the
ones you are changing and output those but not
the others
Or maybe a mix of the two. And in either case you may want to
also use ENABLED_SECTIONS to exclude any doxygen comments that
already exists in those files but unrelated to your changes.
(Of course you could use your own filter to do that, but why
bother when doxygen can do it for you.)
In either case I can envisage difficulties with doxygen not
seeing objects referenced by those parts you are documenting.
It may limit the usefulness of the documentation, but I guess
that is something you can adjust as you go.
A third possibility might to be generate for the full project
but mark all your changed items as belonging to a particular
group (module) using \defgroup, \addtogroup, \ingroup etc.
That way you would get a complete help file, but still easily
identify the changed parts by looking at your particular module.
--
Geoff Worboys
Telesis Computing Pty Ltd
------------------------------------------------------------------------------
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
