Yongwei Wu wrote:
> >> I really like to be able to show all data members in the diagram
> >> without documenting them....
> >
> > Then you should set EXTRACT_PRIVATE to YES.
>
> You missed the "without documenting them" part :-).
>
> It is arguable that the original behaviour might be better. People
> normally want to hide the private data members from documentation, but
> the purpose of the collaboration diagram is to show the relationship
> between this class and other objects. To put it to the extreme: In a
> well-designed class, all data members are normally private; does it
> mean that the collaboration diagram will NOT show anything then?
Well, but does it make sense to generate a documentation without
documenting anything?
It may be difficult to judge without the real example, but...
If you want to show the implementation internals (like the private
members), you probably want to tell the programmer
also what are they good for. If you want to hide the implementation
(i.e. document only the API), then you also want to hide the internal
collaboration. (Say, you want to hide it because it is subject
to changes.)
To summarize, it is natural--in my opinion--not to show the collaboration
diagram for hidden functionality; or, it is natural to show also
the documentation for the revealed parts of the collaboration
graph.
You may consider to generate several versions of the documentation:
one of the end user, one for third party programmers (API), and
one for you with the smallest details.
Regards,
Petr
------------------------------------------------------------------------------
Learn the latest--Visual Studio 2012, SharePoint 2013, SQL 2012, more!
Discover the easy way to master current and previous Microsoft technologies
and advance your career. Get an incredible 1,500+ hours of step-by-step
tutorial videos with LearnDevNow. Subscribe today and save!
http://pubads.g.doubleclick.net/gampad/clk?id=58041391&iu=/4140/ostg.clktrk
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
