Doxygen Test Suite¶

Class¶

class Test

#include “inc/class.h”

This is a test class.

Some details about the Test class

file class.h

Define¶

file define.h

testing defines

This is to test the documentation of defines.

Defines

ABS(x): Computes the absolute value of its argument x.

MAX(x, y): Computes the maximum of x and y.

MIN(x, y): Computes the minimum of x and y.

NOARGS: Define with no arguments

Enum¶

class Test

#include <enum.h>

The class description.

Public Type

TEnum enum

A description of the enum type.

Values:

Val1 -
The description of the first enum value.
Val2 -

AnotherEnum enum

Another enum, with inline docs

Values:

V1 -
value 1
V2 -
value 2

file enum.h

File¶

file file.h

A brief file description.

A more elaborated file description.

Variables

int globalValue

A global integer value.

More details about this value.

Func¶

class Test

#include <func.h>

Test class.

Details about Test.

Public Functions

const char * member(char c, int n)

A member function.

Return

a character pointer.

Parameters

c -
a character.
n -
an integer.

Exceptions

std::out_of_range -
parameter is out of range.

file func.h

Page¶

file page.doc

page page1: Leading text.

page page2: Even more info.

Relates¶

class String

A String class.

Friends

friend int strcmp: Compares two strings.

file relates.cpp

Functions

int strcmp(const String & s1, const String & s2): Compares two strings.

Author¶

class WindowsNT

Windows Nice Try.

Author

Bill Gates

Several species of small furry animals gathered together in a cave and grooving with a picture.

Version

4.0

Date

1996-1998

file author.cpp

page bug

Par¶

class Test

Normal text.

More normal text.

User defined paragraph:: Contents of the paragraph.
: New paragraph under the same heading.
Note: This note consists of two paragraphs. This is the first paragraph.
: And this is the second paragraph.

file par.cpp

Overload¶

class Test

A short description.

More text.

Public Functions

void drawRect(int x, int y, int w, int h): This command draws a rectangle with a left upper corner at ( x , y ), width w and height h.

void drawRect(const Rect & r): This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.

file overload.cpp

Example¶

class Test

A Test class.

More details about this class.

Public Functions

void example()

An example member function.

More details about this function.

file example.cpp

example example_test.cpp

This is an example of how to use the Test class.More details about this example.

void main()
{
  Test t;
  t.example();
}

Include¶

class Test

A test class.

Public Functions

void example(): a member function

file include.cpp

page example

Our main function starts like this: First we create a object t of the Test class. Then we call the example member function After that our little test routine ends.

void main()
{

  Test t;

  t.example();

QtStyle¶

class Test

A test class.

A more elaborate class description.

Public Type

TEnum enum

An enum.

More detailed enum description.

Values:

TVal1 -
Enum value TVal1.
TVal2 -
Enum value TVal2.
TVal3 -
Enum value TVal3.

Public Functions

Test()

A constructor.

A more elaborate description of the constructor.

~Test()

A destructor.

A more elaborate description of the destructor.

int testMe(int a, const char * s)

A normal member taking two arguments and returning an integer value.

Return

The test results

See

Test(), ~Test(), testMeToo() and publicVar()

Parameters

a -
an integer argument.
s -
a constant character pointer.

void testMeToo(char c1, char c2)

A pure virtual member.

See

testMe()

Parameters

c1 -
the first argument.
c2 -
the second argument.

Public Members

enum Test::TEnum * enumPtr

Enum pointer.

Details.

enum Test::TEnum enumVar

Enum variable.

Details.

int publicVar

A public variable.

Details.

int(* handler)(int a, int b)

A function variable.

Details.

file qtstyle.cpp

JdStyle¶

class Test

A test class.

A more elaborate class description.

Public Type

TEnum enum

An enum.

More detailed enum description.

Values:

TVal1 -
enum value TVal1.
TVal2 -
enum value TVal2.
TVal3 -
enum value TVal3.

Public Functions

Test()

A constructor.

A more elaborate description of the constructor.

~Test()

A destructor.

A more elaborate description of the destructor.

int testMe(int a, const char * s)

a normal member taking two arguments and returning an integer value.

See

Return

The test results

Parameters

a -
an integer argument.
s -
a constant character pointer.

void testMeToo(char c1, char c2)

A pure virtual member.

See

testMe()

Parameters

c1 -
the first argument.
c2 -
the second argument.

Public Members

enum Test::TEnum * enumPtr

enum pointer.

Details.

enum Test::TEnum enumVar

enum variable.

Details.

int publicVar

a public variable.

Details.

int(* handler)(int a, int b)

a function variable.

Details.

file jdstyle.cpp

StructCmd¶

file structcmd.h

A Documented file.

Details.

Defines

MAX(a, b)

A macro that returns the maximum of a and b.

Details.

Typedefs

typedef unsigned int UINT32

A type definition for a .

Details.

Functions

int open(const char * pathname, int flags)

Opens a file descriptor.

Detailed description.

Parameters

pathname -
The name of the descriptor.
flags -
Opening flags.

int close(int fd)

Closes the file descriptor fd.

Parameters

fd -
The descriptor to close.

size_t write(int fd, const char * buf, size_t count)

Writes count bytes from buf to the file descriptor fd.

Parameters

fd -
The descriptor to write to.
buf -
The data buffer to write.
count -
The number of bytes to write.

int read(int fd, char * buf, size_t count)

Read bytes from a file descriptor.

Parameters

fd -
The descriptor to read from.
buf -
The buffer to read into.
count -
The number of bytes to read.

Variables

int errno

Contains the last error code.

Warning: Not thread safe!

Autolink¶

class Test

Since this documentation block belongs to the class Test no link to Test is generated.

Two ways to link to a constructor are: Test and Test().

Links to the destructor are: ~Test and ~Test().

A link to a member in this class: member().

More specific links to the each of the overloaded members: member(int) and member(int,int).

A link to the variable var.

A link to the global typedef B.

A link to the global enumeration type GlobEnum.

A link to the define ABS(x).

A link to a variable using another text as a link.

A link to the enumeration type EType.

A link to some enumeration values: Val1 and GVal1.

And last but not least a link to a file: autolink.cpp.

See: Inside a see also section any word is checked, so EType, Val1, GVal1, ~Test and member will be replaced by links in HTML.

Public Type

EType enum

An enum type.

More details

Values:

Val1 -
enum value 1
Val2 -
enum value 2

Public Functions

Test()

constructor

details.

~Test()

destructor

details.

void member(int)

A member function.

Details.

void member(int, int)

An overloaded member function.

Details

Protected Attributes

int var: A member variable.

file autolink.cpp

Testing automatic link generation.

A link to a member of the Test class: Test::member,

More specific links to the each of the overloaded members: Test::member(int) and Test::member(int,int)

A link to a protected member variable of Test: Test::var,

A link to the global enumeration type GlobEnum.

A link to the define ABS(x).

A link to the destructor of the Test class: Test::~Test,

A link to the typedef B.

A link to the enumeration type Test::EType

A link to some enumeration values Test::Val1 and GVal2

Defines

ABS(x): A macro definition.

Typedefs

typedef Test B: A type definition.

Enums

GlobEnum enum

A global enum.

Values:

GVal1 -
global enum value 1
GVal2 -
global enum value 2

Variables

int globVar: A global variable.

ResTypeDef¶

struct CoordStruct

A coordinate pair.

Public Members

float x: The x coordinate

float y: The y coordinate

file restypedef.cpp

An example of resolving typedefs.

Typedefs

typedef CoordStruct Coord: Creates a type name for CoordStruct

Functions

Coord add(Coord c1, Coord c2): This function returns the addition of c1 and c2, i.e: (c1.x+c2.x,c1.y+c2.y)

AfterDoc¶

class Test

#include <afterdoc.h>

A test class

Public Type

EnumType enum

An enum type.

The documentation block cannot be put after the enum!

Values:

EVal1 -
enum value 1
EVal2 -
enum value 2

Public Functions

void member(): a member function.

Protected Attributes

int value: an integer value

file afterdoc.h

Template¶

template <class T, int i = 100> class Test

A template class

Public Functions

Test(): The constructor of the template class

Test(const Test & t): The copy constructor

template <class T> class Test< T * >

A partial template specialization

Public Functions

Test(): The constructor of the partial specialization

template <> class Test< void *, 200 >

complete specialization

Public Functions

Test(): The constructor of the specialization

file templ.cpp

Tag¶

class Tag

A class that is inherited from the external class Test.

Public Functions

void example(): an overloaded member.

file tag.cpp

Group¶

class C1: class C1 in group 1

class C2: class C2 in group 1

class C3: class C3 in group 2

class C4: class C4 in group 2

class C5: class C5 in the third group.

namespace N1

namespace N1 is in four groups

Also see This is another section in group 5

See: The first group, The Second Group, The Third Group, The Fourth Group

file group.cpp

this file in group 3

Functions

void func(): function in group 1

void func2(): another function in group 1

void func3(): yet another function in group 1

group group1

This is the first group.

Diagrams¶

class A

#include <diagrams_a.h>

Public Members

A * m_self

class B

#include <diagrams_b.h>

Public Members

A * m_a

class C

#include <diagrams_c.h>

Public Members

D * m_d

class D

#include <diagrams_d.h>

Public Members

C m_c

class E: #include <diagrams_e.h>

file diagrams_a.h

file diagrams_b.h

file diagrams_c.h: #include “diagrams_c.h”

file diagrams_d.h: #include “diagrams_a.h”#include “diagrams_b.h”

file diagrams_e.h: #include “diagrams_d.h”

Memgrp¶

class Test

A class.

Details

Group2

Description of group 2.

void func1InGroup2()

Function 1 in group 2.

Details.

void func2InGroup2()

Function 2 in group 2.

Details.

Unnamed Group

void func1InGroup1()

Same documentation for both members.

Details

void func2InGroup1()

Same documentation for both members.

Details

Public Functions

void ungroupedFunction()

Function without group.

Details.

file memgrp.cpp

docs for this file

Unnamed Group

A: one description for all members of this group (because DISTRIBUTE_GROUP_DOC is YES in the config file)

B: one description for all members of this group (because DISTRIBUTE_GROUP_DOC is YES in the config file)

void glob_func(): one description for all members of this group (because DISTRIBUTE_GROUP_DOC is YES in the config file)

Docstring¶

class docstring::PyClass

Documentation for a class.

More details.

Public Functions

def __init__()

The constructor.

def PyMethod()

Documentation for a method.

Private Members

_memVar

namespace docstring

@package docstring
Documentation for this module.

More details.

Functions

def func()

Documentation for a function.

More details.

file docstring.py

PyExample¶

class pyexample::PyClass

Documentation for a class.

More details.

Public Functions

def __init__(): The constructor.

def PyMethod()

Documentation for a method.

Parameters

self -
The object pointer.

Public Static Attributes

int classVar: A class variable.

Private Members

_memVar: a member variable

namespace pyexample

Documentation for this module.

More details.

Functions

def func()

Documentation for a function.

More details.

file pyexample.py

Mux¶

class mux_using_with::behavior

Architecture definition of the MUX.

More details about this mux element.

class mux_using_with

Mux entity brief description.

Public Members

in din_0std_logic

Mux first input.

Detailed description of this mux design element.

in din_1std_logic: Mux Second input.

in selstd_logic: Select input.

out mux_outstd_logic: Mux output.

_library_ ieeeieee: Use standard library.

_use_ ieee.std_logic_1164.allieee.std_logic_1164.all: Use logic elements.

file mux.vhdl: 2:1 Mux using with-select

Manual¶

struct Car

Car type.

Car class.

Protected Attributes

Vehicle base: Base class.

struct Object

Object type.

Base object class.

Public Functions

Object * objRef(Object * obj): Increments object reference count by one.

Object * objUnref(Object * obj): Decrements object reference count by one.

Private Members

int ref: Reference count.

struct Truck

Truck type.

Truck class.

Protected Attributes

Vehicle base: Base class.

struct Vehicle

Vehicle type.

Vehicle class.

Public Functions

void vehicleStart(Vehicle * obj): Starts the vehicle.

void vehicleStop(Vehicle * obj): Stops the vehicle.

Protected Attributes

Object base: Base class.

file manual.c

Functions

int main(void)

Main function.

Ref vehicleStart(), objRef(), objUnref().

Breathe v2.0.0 documentation