Gaudi Framework
	Generated: 22 Nov 2000

             

---

ClassName Class Reference

The first sentence is used as a summary description by the documentation tool. More...

#include <Package/ClassName.h>

Inheritance diagram for ClassName:

List of all members.

Public Types
typedef std::list<IService*>	ListSvc
typedef std::map<const std::string, const ISvcFactory*>	MapFactory
Public Methods
	ClassName (Type1 argument1, Type2 argument2)
	default creator.
virtual	~ClassName ()
	virtual destructor.
virtual void	method1 ()
	Description of the method. More...
virtual int	method2 ( Type1 argument1, Type2 argument2 )
	Another method with some arguments. More...
StatusCode	method3 ()
	Yet another method of this class.
Protected Attributes
int	m_refcount
	Reference counter.
Type1*	m_member2
	Pointer to an object of type Type1.
Type2&	m_member3
	Reference to an object of type Type2.

---

Detailed Description

The first sentence is used as a summary description by the documentation tool.

The description of a class is expected to be found before the class declaration in the .h file. The code is documented follwing the JavaDoc style. Using the multi-line documentation block or the simple line documentation as is shown in this example. The cvs keyword in the first line of the file will be expanded by the code management tool to include the file path name, revision number, the author and the state.

Author(s):

Author Name , Another Name

Date:

20/11/2000

---

Member Typedef Documentation

typedef std::list<IService*> ClassName::ListSvc

typedef std::map<const std::string, const ISvcFactory*> ClassName::MapFactory

---

Constructor & Destructor Documentation

ClassName::ClassName ( Type1 argument1, Type2 argument2 )

default creator.

ClassName::~ClassName ( ) [virtual]

virtual destructor.

---

Member Function Documentation

void ClassName::method1 ( ) [virtual]

Description of the method. Again the first sentence is used as a summary by the documentation tool. It is also expected to find comments before the method declaration. { // Implementation of method1. In order to not take unnecessary width // we should use 2 spaces for each identation. if ( bla & bla ) { for ( i = 0; i < n; i++ ) { // do something useful here ... } } }

int ClassName::method2 ( Type1 argument1, Type2 argument2 ) [virtual]

Another method with some arguments. The arguments can be documented as normal inline comments Returns: status code Parameters: argument1   this is the first argument argument2   this is the second argument which goes after the first argument { int i; float f; for ( i = 0; i < 1000; i++ ) { // something here } return i; }

StatusCode ClassName::method3 ( )

Yet another method of this class. { return StatusCode::SUCCESS; }

---

Member Data Documentation

Type1 * ClassName::m_member2 [protected]

Pointer to an object of type Type1.

Type2 & ClassName::m_member3 [protected]

Reference to an object of type Type2.

int ClassName::m_refcount [protected]

Reference counter.

---

The documentation for this class was generated from the following files:

• ClassName.h
• ClassName.cpp

---