This is the mail archive of the libstdc++@sources.redhat.com mailing list for the libstdc++ project.

Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]

Re: Doxygen (was Re: Proposed man pages: <vector> sample, RFC)

Quoting Benjamin Kosnik <bkoz@redhat.com>:

> > I just looked at doxygen for our project here, and it looks like it
> > works really good.  It was rather easy to set up with the graphical
> > wizard.  Definitely download the optional package from AT&T Research
> for
> > the inheritance and collaboration graphs.
> 
> could you please provide a URL for the optional packages?

http://www.research.att.com/sw/tools/graphviz/

> Also, is there
> anyway you could provide an example image for either or both of the
> graphs?

Check the attached files.  Note that this is from 2.90.8 snapshot, and that I
didn't add _any_ code documentation in the form of javadoc/QT comments so the
only thing that's meaningful are the graphs.

> > On an unrelated note, will the new snapshot (2.90.9) be compilable
> under
> > gcc 2.95.2?
> 
> Err....2.91, you mean! 
> 
> Here's hoping.

You mean that the Fridayish release is 2.91, or that 2.91 won't compile under
gcc 2.95.2, but a future one called 2.91 will?  (I'm a little slow...)

--
George T. Talbot
<george@moberg.com>
Title: Member List
Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

std::basic_iostream Member List

This is the complete list of members for std::basic_iostream, including all inherited members.
Generated at Tue Nov 14 11:54:05 2000 for Standard C++ Library by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000
Title: std::basic_iostream Template Class Reference
Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

std::basic_iostream Template Class Reference

#include <std_istream.h>

Inheritance diagram for std::basic_iostream

Inheritance graph

[legend]
Collaboration diagram for std::basic_iostream:

Collaboration graph

[legend]
List of all members.

Public Types

typedef basic_istream<_CharT,
_Traits> 		__istream_type
typedef basic_ostream<_CharT,
_Traits> 		__ostream_type

Public Methods

 basic_iostream (basic_streambuf<_CharT, _Traits>* __sb)
virtual ~basic_iostream ()

Member Typedef Documentation

template<typename_CharT, typename_Traits>
typedef basic_istream<_CharT, _Traits> std::basic_iostream<_CharT, _Traits>::__istream_type
 

Reimplemented from std::basic_istream.

Definition at line 273 of file std_istream.h.

template<typename_CharT, typename_Traits>
typedef basic_ostream<_CharT, _Traits> std::basic_iostream<_CharT, _Traits>::__ostream_type
 

Reimplemented from std::basic_ostream.

Definition at line 274 of file std_istream.h.

Constructor & Destructor Documentation

template<typename_CharT, typename_Traits>
std::basic_iostream<_CharT, _Traits>::basic_iostream<_CharT, _Traits> ( basic_streambuf< _CharT,_Traits >* __sb ) [explicit]
 

Definition at line 277 of file std_istream.h.

template<typename_CharT, typename_Traits>
std::basic_iostream<_CharT, _Traits>::~basic_iostream<_CharT, _Traits> ( ) [inline, virtual]
 

Definition at line 282 of file std_istream.h.

The documentation for this class was generated from the following file:
Generated at Tue Nov 14 11:54:05 2000 for Standard C++ Library by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000

GIF image

GIF image

GIF image

Title: Graph Legend
Main Page   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   File Members  

Graph Legend

This page explains how to interpret the graphs that are generated by doxygen.

Consider the following example: 

/*! Invisible class because of truncation */
class Invisible { };

/*! Truncated class, inheritance relation is hidden */
class Truncated : public Invisible { };

/* Class not documented with doxygen comments */
class Undocumented { };

/*! Class that is inherited using public inheritance */
class PublicBase : public Truncated { };

/*! Class that is inherited using protected inheritance */
class ProtectedBase { };

/*! Class that is inherited using private inheritance */
class PrivateBase { };

/*! Class that is used by the Inherited class */
class Used { };

/*! Super class that inherits a number of other classes */
class Inherited : public PublicBase,
                  protected ProtectedBase,
                  private PrivateBase,
                  public Undocumented
{
  private:
    Used *m_usedClass;
};
If the MAX_DOT_GRAPH_HEIGHT tag in the configuration file is set to 200 this will result in the following graph:

The boxes in the above graph have the following meaning:

  • A filled black box represents the struct or class for which the graph is generated.
  • A box with a black border denotes a documented struct or class.
  • A box with a grey border denotes an undocumented struct or class.
  • A box with a red border denotes a documented struct or class for which not all inheritance/containment relations are shown. A graph is truncated if it does not fit within the specified boundaries.
The arrows have the following meaning:
  • A dark blue arrow is used to visualize a public inheritance relation between two classes.
  • A dark green arrow is used for protected inheritance.
  • A dark red arrow is used for private inheritance.
  • A purple dashed arrow is used if a class is contained or used by another class. The arrow is labeled with the variable(s) through which the pointed class or struct is accessible.
Generated at Tue Nov 14 11:54:43 2000 for Standard C++ Library by doxygen1.2.1 written by Dimitri van Heesch, © 1997-2000
Index Nav: [Date Index] [Subject Index] [Author Index] [Thread Index]
Message Nav: [Date Prev] [Date Next] [Thread Prev] [Thread Next]