[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:       Allen Winter <winter () kde ! org>
Date:       2009-02-13 17:30:53
Message-ID: 200902131230.54016.winter () kde ! org
[Download RAW message or body]

On Friday 13 February 2009 12:11:40 pm Frans Englich wrote:
> On Friday 13 February 2009 16:07:35 karthik amirapu wrote:
> > Hi Francs,
> >
> > I believe you need to use \cond and \endcond tags to hide completely. An
> > example of the usage would be-
> 
> Indeed. However, I think it's a cumbersome solution for something common: 
> having internal classes. Imagine a large project with thousand internal 
> classes, having to use conditionals isn't pretty.
> 
> If there's an acknowledged need to hide paragraphs using @internal, the need 
> to hide classes and namespaces should sound sensible. Maybe the behavior of 
> @internal should be changed to hide classes and namespaces if placed on such 
> code blocks, or maybe something like @internalEntity, I don't know, thinking 
> out loud :)
> 
> 
Yes, we'd love something like @internalEntity in KDE.

I've personally added dozens and dozens of @cond - endcond blocks
in the KDE source.. looks sorta ugly. OTOH, the @cond block solution
gives you the opportunity to print the documentation for internal classes
simply by defining a variable if you need to later.


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