PndDocuSample Class Reference

Documentation Sample Class. More...

#include <PndDocuSample.h>

Public Member Functions
	PndDocuSample ()
	Default constructor does not need much of a description. More...
	PndDocuSample (std::string _s, int _i)
	Proper constructor. More...
	~PndDocuSample ()
	Default destructor. More...
void	SetString (std::string _s)
	Set the string. More...
void	SetNumber (int _i)
	Set the number. More...
std::string	GetString ()
	Returns the current string. More...
int	GetNumber ()
	Return the current number. More...
void	PrintValues ()
	You can either document in the header file... More...
void	AddString ()
void	SquareNumber ()

Detailed Description

Documentation Sample Class.

Sample Documentation Class

This file highlights documentation with Doxygen. Please see the individual parts for more information.

The current paragraph is designated for a long description of the class, possibly also with run / invocation instructions. Since this can be quite extensive, Doxygen provides functionality to properly format text. Two ways of styling text are supported, HTML and Markdown syntax. I will shortly highlight the latter, as it is a neat, quite natural way of styling text.

Markdown

Markdown is the a markup language which lets you write styled text.

Headings are created with a number of consecutive hashes (#), text can be bold or in italics. The following paragraph concisely highlights some features and is followed by the code used to generate it.

For more, see the original page or this slightly more extensive example.

Example

This text can be italic, can be bold, or with fixed-width. Also, a link can be set and an image included:

Code (uninterpreted) can be included in a block with three tildes (both for start and end of block). Optionally, a language can be specified which is used to generate syntax highlighted code.

int i = 0;
i++;

Lists

• An unnumbered
• list is done
• Like this

And

1. A numbered
2. List is done
3. Like this

Code

The code used to generated the last section is the following:

### Example
This text can be *italic*, can be *bold*, or with `fixed-width`. Also, a [link](http://panda.gsi.de) can be set and an image included:
![PANDA Logo](http://www-panda.gsi.de/html/org/logo/PandaLogo2_web.gif "The PANDA logo")

#### Lists
  * An unnumbered
  * list is done
  * Like this

And

  1. A numbered
  2. List is done
  3. Like this

Formulas

If your class / method needs some mathematical description, you can use LaTeX to create formulas

\[ 55 = \sum_{i = 1}^{10} i \]

The formulas are rendered either in-browser with MathJax or during generation of the documentation as an image, depending on the configuration in the doxygen config file.

Author

Andreas Herten a.her.nosp@m.ten@.nosp@m.fz-ju.nosp@m.elic.nosp@m.h.de, FZJ

Version

1.0

Date

May 11, 2015

Copyright

GNU Public License

Definition at line 82 of file PndDocuSample.h.

Constructor & Destructor Documentation

PndDocuSample() [1/2]

PndDocuSample::PndDocuSample

(

)

Default constructor does not need much of a description.

PndDocuSample() [2/2]

PndDocuSample::PndDocuSample	(	std::string	_s,
		int	_i
	)

Proper constructor.

Use this constructor to directly initialize the class

Remarks

You should use this constructor

Parameters

_s	A string with some information
_i	Some integer. Does not need to be 42.

~PndDocuSample()

PndDocuSample::~PndDocuSample

(

)

Default destructor.

Member Function Documentation

AddString()

void PndDocuSample::AddString

(

)

Referenced by GetNumber().

GetNumber()

int PndDocuSample::GetNumber ( )

inline

Return the current number.

Returns

The current content of fNumber

Definition at line 129 of file PndDocuSample.h.

References AddString(), PrintValues(), and SquareNumber().

{ return fNumber; };

GetString()

std::string PndDocuSample::GetString ( void  )

inline

Returns the current string.

Returns

The current content of fString

Definition at line 124 of file PndDocuSample.h.

{ return fString; };

PrintValues()

void PndDocuSample::PrintValues

(

)

You can either document in the header file...

This is true for all descriptions. They are combined.

Referenced by GetNumber().

SetNumber()

void PndDocuSample::SetNumber ( int  _i )

inline

Set the number.

Note

Notes are different ways of giving attention to something specific. Like this panda.

Parameters

_i

Number

Definition at line 118 of file PndDocuSample.h.

{ fNumber = _i; };

SetString()

void PndDocuSample::SetString ( std::string  _s )

inline

Set the string.

Parameters

[in]

_s

The input string. You can give additional directions of the variable. It can be an input, which should be the case usually, or on output, e.g. if you provide a pointer or reference to a variable to be filled in the course of this method. Notice that in the description of this method the usually one-line param description was extended by using parblock.

Definition at line 111 of file PndDocuSample.h.

{ fString = _s; };

SquareNumber()

void PndDocuSample::SquareNumber

(

)

Referenced by GetNumber().

---

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

• PndDocuSample.h