[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:       "J.S. van Bethlehem" <j.s.van.bethlehem () astro ! rug ! nl>
Date:       2009-02-17 9:26:08
Message-ID: 499A82B0.3050502 () astro ! rug ! nl
[Download RAW message or body]

I'm quite new to Doxygen, so correct if I'm wrong, but don't you get
precisely the wanted effect if you just don't comment these internal
classes with the special doxygen blocks? (ie, just use /* */ for
documentation)

Regards, Jakob


Dimitri Van Heesch wrote:
> Hi Frans,
> 
> On 13 feb 2009, at 15:57, Frans Englich wrote:
> 
>> Hi,
>>
>> I'm having trouble with hiding internal classes & namespaces. I  
>> would expect
>> that this:
>>
>> /**
>> * @short Short for InternalNamespace
>> * @internal
>> */
>> namespace InternalNamespace
>> {
>>    /**
>>     * @short Short for ClassInInternalNamespace
>>     */
>>    class ClassInInternalNamespace
>>    {
>>    };
>> }
>>
>> would result in the class and namespace not being listed at all.  
>> Same for:
>>
>>    /**
>>     * @short Short for Class.
>>     * @internal
>>     */
>>    class Class
>>    {
>>    };
>>
>>
>> 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.
> 
> Regards,
>    Dimitri
> 
> 
> 
> 
> ------------------------------------------------------------------------------
> 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

------------------------------------------------------------------------------
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]