[prev in list] [next in list] [prev in thread] [next in thread] 

List:       doxygen-users
Subject:    Re: [Doxygen-users] Not listing internal classes & namespaces
From:       "Frans Englich" <frans.englich () telia ! com>
Date:       2009-02-14 23:44:02
Message-ID: 1234655042.4474.1300404551 () webmail ! messagingengine ! com
[Download RAW message or body]


On Sat, 14 Feb 2009 20:58:06 +0100, "Dimitri Van Heesch"
<doxygen@gmail.com> said:
[...]

> > What I did find out was that @internal hide the detailed  
> > description, not the
> > class as a whole. How does one achieve the latter? It must be possible
> > somehow, otherwise I presume it wouldn't be possible to document  
> > internal
> > classes/namespaces.
> 
> Besides using \cond or doxygen's C-preprocessor, this is also possible  
> without
> editing the code by using EXCLUDE_SYMBOLS like so:
> 
> EXCLUDE_SYMBOLS = InternalNamespace InternalNamespace::*
> 
> This tells doxygen to exclude InternalNamespace itself and all symbols  
> within its scope.

Yes, still I think this is cumbersome. For instance, it counteracts
modularity by having to place information about a class(that it's
internal) in a central place, instead of to locate it with the actual
class. This is cumbersome when merging/modularizing projects. 

Another problem is that it's not about unconditionally excluding. And it
also applies to files, directories, groups, and possibly any other
"thing" in doxygen. It's not about completely skipping it(like
EXCLUDE_PATTERNS do), but to be able to say "these things are only for
internal development, and they should only be shown when generating the
docs for internal development." One can sort of hack it (maybe?) by
adding to EXCLUDE_PATTERNS, EXCLUDE_SYMBOLS, and using conditionals for
groups and other things, but doesn't it sound like @internalEntity would
be a very useful feature?


Cheers,

                Frans

------------------------------------------------------------------------------
Open Source Business Conference (OSBC), March 24-25, 2009, San Francisco, CA
-OSBC tackles the biggest issue in open source: Open Sourcing the Enterprise
-Strategies to boost innovation and cut costs with open source participation
-Receive a $600 discount off the registration fee with the source code: SFAD
http://p.sf.net/sfu/XcvMzF8H
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]