[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:       Dimitri Van Heesch <doxygen () gmail ! com>
Date:       2009-02-14 19:58:06
Message-ID: D037F4E8-AB51-41A1-8DEC-646C23D7E7E1 () gmail ! com
[Download RAW message or body]


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
[prev in list] [next in list] [prev in thread] [next in thread]