rrauch wrote:
> Hi All,
> I am trying to document our work for WEC7 BSP with doxygen
> and encountered a problem now.
> Within the DSP there could be several similar drivers,
> which are linked as dll to final WEC7 image....
> Within the DLL's source code there are same Class names and
> member functions, which are named identically.
> doxygen seems not to be able to handle this. inside the BSP
> project it is displaying only the documentation of
> implementation, which was found firstly.
> Is it anyhow possible to document a project, which is
> structured like this? I do not want to generate a seperate
> doxygen documentation for each driver of BSP...
>
> Any ideas?
But what is it that you do want in this situation?
There appear to be two possibilities:
1) Each set of identical classes describes an identical
interface, just a different implementation, so only one lot
of documentation is necessary. In which case:
- document the classes and functions externally and then
completely exclude these units from doxygen
or
- document exactly one of the drivers (generically) and
then exclude the others (either at the file level or by
using the previously mentioned ENABLED_SECTIONS feature
and not enabling those blocks.
If you want all relevant files linked to that one set of
documentation try using \relatesalso in the file doc (I've not
tried using it at the file level - if that doesn't work you may
need a dummy object to make the link).
OR
2) Each set of classes is not really identical and needs to be
documented separately. In which case you could try defining
pairs of macros to be used like this:
DOC_NAMESPACE_dllname_BEGIN
// code
DOC_NAMESPACE_dllname_END
These would be defined to expand to blank for the C compiiler
but would expand to
namespace dllname {
// code
}
when run through doxygen.
--
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
