As of writing this manual EDoc++ is in an Alpha Stage (ver 0.2.1). This means it is not as functional or as easy to use as it will be for the first full release (ver 1.0.0). It also means that it may contain a few bugs that have not been revealed during internal testing.
I don't want people to try EDoc++ now and then never try Edoc++
again because of usability issues that may exist at the moment. If you
find EDoc++ difficult to use and are about to uninstall it, then I would
love to hear about your experiences
(<edoc-main@lists.sourceforge.net>) so it can be improved.
Also it may be helpful to subscribe to the EDoc++ announce mailing list:
https://lists.sourceforge.net/lists/listinfo/edoc-main
to receive information about new updates to EDoc++.
Things that I expect to be improved before release 1.0 include:
Improve the usability of EDoc++
Note: I wish to achieve this first. Making this tool easy or easier to use will help people to adopt it in their projects.
Improving the usability of EDoc++ will require feedback from
users as to how best they think EDoc++ can be improved. My general
goal is to make it so that EDoc++ can be used in most situations
without the user having to create a suppressions file (.eds) and
without having to hunt down the EDoc++ data files (.edc) that are
needed for the merging process. If you can think of other improvements
I would love to hear about them:
<edoc-main@lists.sourceforge.net> The main obstacle for
this is to implement the GCC modification as a GCC plugin. The
official GCC plugin branch should be developed soon if the FSF manages
to complete updates to the GPL license to cover this case for
GCC.
Doxygen integration
Currently the Doxygen integration is not as good as it could be. The end goal is to be able to get the generated documentation to be used by an un-patched release of Doxygen without the user having to provide any suppressions to rename functions in EDoc++.
Default suppressions for standard libraries
When using EDoc++ to process code that includes standard libraries like libstdc++, there are a number of warnings that occur that the user is really not interested in. The idea here is to make EDoc++ as useful in the general case out of the box without having to include common suppressions etc. Some suppressions have been generated already, but these can be improved.