Doxygen Test Suite¶

Class¶

class Test¶

#include “inc/class.h”

This is a test class.

Some details about the Test class

class Test3¶

file class.h

Interface¶

interface TestInterface¶

#include “inc/interface.h”

This is a test interface.

Some details about the TestInterface interface

file interface.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 Test4¶

#include <enum.h>

The class description.

Public Types

enum TEnum¶

A description of the enum type.

Values:

enumerator Val1¶: The description of the first enum value.

enumerator Val2¶

enum AnotherEnum¶

Another enum, with inline docs

Values:

enumerator V1¶: value 1

enumerator V2¶: value 2

enum class AnotherScopedEnum : long¶

Values:

enumerator V1¶: value 1

enumerator 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 Test6¶

#include <func.h>

Test6 class.

Details about Test6.

Public Functions

const char *member(char, int)¶

A member function.

Parameters

c – a character.
n – an integer.

Throws

std::out_of_range – parameter is out of range.

Returns

a character pointer.

file func.h

Functions

void myFunc(int *a, int *b, int *c)¶

Doing important things with parameter directions.

Parameters

a – [out] output
b – [in] input
c – [inout] input but gets rewritten

Page¶

file page.doc

page page1: Leading text.

An example section¶

This page contains the subsections The first subsection and The second subsection. For more info see page Another page.

The first subsection¶

Text.

The second subsection¶

More text.

page page2: Even more info.

Relates¶

class String¶

A String class.

Friends

friend int strcmp(const String&, const String&)¶: Compares two strings.

void stringDebug()¶: A string debug function.

file relates.cpp

Functions

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

Author¶

class WindowsNT¶

Windows Nice Try.

Bug:

It crashes a lot and requires huge amounts of memory.

The class introduces the more bugs, the longer it is used.

Author: Bill Gates
Author: Several species of small furry animals gathered together in a cave and grooving with a picture.
Version: 4.0
Date: 1996-1998

Warning

This class may explode in your face.

Warning

If you inherit anything from this class, you’re doomed.

file author.cpp

page bug

Class WindowsNT

It crashes a lot and requires huge amounts of memory.

The class introduces the more bugs, the longer it is used.

Par¶

class Test11¶

Normal text.

More normal text.

User defined paragraph:: Contents of the paragraph.
: New paragraph under the same heading.
: And this is the second paragraph.

Note

This note consists of two paragraphs. This is the first paragraph.

file par.cpp

Parblock¶

class Test15¶

Normal text.

A paragraph followed by a paragraph block:

Contents of the first paragraph in the block.

New paragraph under the same heading.

More normal text.

Note

This note consists of three paragraphs in a block.

This is the first paragraph in the block.

And this is the second paragraph in the block.

And still a third paragraph in the block.

file parblock.cpp

Overload¶

class Test10¶

A short description.

More text.

Public Functions

void drawRect(int, int, int, int)¶: 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 Test5¶

A Test5 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 Test5 class.

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

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

Include¶

class Test7¶

A test class.

Public Functions

void example()¶: a member function

file include.cpp

page example

Our main function starts like this:

void main()
{

First we create a object t of the Test7 class.

  Test7 t;

Then we call the example member function

  t.example();

After that our little test routine ends.

QtStyle¶

class Test12¶

A test class.

A more elaborate class description.

Public Types

enum TEnum¶

An enum.

More detailed enum description.

Values:

enumerator TVal1¶: Enum value TVal1.

enumerator TVal2¶: Enum value TVal2.

enumerator TVal3¶: Enum value TVal3.

Public Functions

Test12()¶

A constructor.

A more elaborate description of the constructor.

~Test12()¶

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.

Parameters

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

Returns

The test results

virtual void testMeToo(char c1, char c2) = 0¶

A pure virtual member.

See also

testMe()

Parameters

c1 – the first argument.
c2 – the second argument.

Public Members

enum Test12::TEnum *enumPtr¶

Enum pointer.

Details.

enum Test12::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 Test8¶

A test class.

A more elaborate class description.

Public Types

enum TEnum¶

An enum.

More detailed enum description.

Values:

enumerator TVal1¶: enum value TVal1.

enumerator TVal2¶: enum value TVal2.

enumerator TVal3¶: enum value TVal3.

Public Functions

Test8()¶

A constructor.

A more elaborate description of the constructor.

~Test8()¶

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 also

See also

See also

See also

Parameters

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

Returns

The test results

virtual void testMeToo(char c1, char c2) = 0¶

A pure virtual member.

See also

testMe()

Parameters

c1 – the first argument.
c2 – the second argument.

Public Members

enum Test8::TEnum *enumPtr¶

enum pointer.

Details.

enum Test8::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*, int)¶

Opens a file descriptor.

Detailed description.

Parameters

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

int close(int)¶

Closes the file descriptor fd.

Parameters: fd – The descriptor to close.

size_t write(int, const char*, size_t)¶

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, char*, size_t)¶

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 Test2¶

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

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

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

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 Test2TypeDef.

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 also

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

Public Types

enum EType¶

An enum type.

More details

Values:

enumerator Val1¶: enum value 1

enumerator Val2¶: enum value 2

Public Functions

Test2()¶

constructor

details.

~Test2()¶

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 Test2 class: Test2::member,

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

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

A link to the global variable globVar.

A link to the global enumeration type GlobEnum.

A link to the define ABS(x).

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

A link to the typedef Test2TypeDef.

A link to the enumeration type Test2::EType

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

Defines

ABS(x): A macro definition.

Typedefs

typedef Test2 Test2TypeDef¶: A type definition.

Enums

enum GlobEnum¶

A global enum.

Values:

enumerator GVal1¶: global enum value 1

enumerator 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 Test1¶

#include <afterdoc.h>

A test class

Public Types

enum EnumType¶

An enum type.

The documentation block cannot be put after the enum!

Values:

enumerator EVal1¶: enum value 1

enumerator 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 Test14¶

A template class

Public Functions

Test14()¶: The constructor of the template class

Test14(const Test14&)¶: The copy constructor

template<class T> class Test14<T*> : public Test14<void*, 200>¶

A partial template specialization

Public Functions

Test14()¶: The constructor of the partial specialization

template<> class Test14<void*, 200>¶

complete specialization

Subclassed by Test14< T * >

Public Functions

Test14()¶: The constructor of the specialization

file templ.cpp

Tag¶

class Tag : public Test13¶

A class that is inherited from the external class Test13.

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

file group.cpp

this file in group 3

Functions

void func1()¶: 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>

Subclassed by C, D

Public Members

A *m_self¶

class B¶

#include <diagrams_b.h>

Subclassed by D

Public Members

A *m_a¶

class C : public A ¶

#include <diagrams_c.h>

Public Members

D *m_d¶

class D : protected virtual A, private B ¶

#include <diagrams_d.h>

Subclassed by E

Public Members

C m_c¶

class E : public D ¶: #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 Test9¶

A class.

Details

Group2

Description of group 2.

void func1InGroup2()¶

Function 1 in group 2.

Details.

void func2InGroup2()¶

Function 2 in group 2.

Details.

Public Functions

void func1InGroup1()¶

Same documentation for both members.

Details

void func2InGroup1()¶

void ungroupedFunction()¶

Function without group.

Details.

file memgrp.cpp

docs for this file

Group2

Description of group 2.

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

__init__(self)¶

The constructor.

PyMethod(self)¶

Documentation for a method.

Private Members

_memVar¶

module docstring¶

@package docstring
Documentation for this module.

More details.

Functions

func()¶

Documentation for a function.

More details.

file docstring.py

PyExample¶

class pyexample.PyClass¶

Documentation for a class.

More details.

Public Functions

__init__(self)¶: The constructor.

PyMethod(self)¶

Documentation for a method.

Parameters: self – The object pointer.

Public Static Attributes

classVar = 0¶: A class variable.

Private Members

_memVar¶: a member variable

module pyexample¶

Documentation for this module.

More details.

Functions

func()¶

Documentation for a function.

More details.

file pyexample.py

Mux¶

class behavior¶

Architecture definition of the MUX.

More details about this mux element.

class mux_using_with¶

Mux entity brief description Detailed description of this mux design element.

Public Members

in din_0 std_logic: Mux first input.

in din_1 std_logic: Mux Second input.

in sel std_logic: Select input.

out mux_out std_logic: Mux output.

_library_ ieee ieee: Use standard library.

_use_ std_logic_1164 std_logic_1164: Use logic elements.

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

Manual¶

struct Car : public Vehicle ¶

Car type.

Car class.

Protected Attributes

Vehicle base¶: Base class.

struct Object¶

Object type.

Base object class.

Subclassed by Vehicle

Public Static Functions

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

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

Private Members

int ref¶: Reference count.

struct Truck : public Vehicle ¶

Truck type.

Truck class.

Protected Attributes

Vehicle base¶: Base class.

struct Vehicle : public Object ¶

Vehicle type.

Vehicle class.

Subclassed by Car, Truck

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().

Doxygen Test Suite¶

Class¶

Interface¶

Define¶

Enum¶

File¶

Func¶

Page¶

An example section¶

The first subsection¶

The second subsection¶

Relates¶

Author¶

Par¶

Parblock¶

Overload¶

Example¶

Include¶

QtStyle¶

JdStyle¶

StructCmd¶

Autolink¶

ResTypeDef¶

AfterDoc¶

Template¶

Tag¶

Group¶

Diagrams¶

Memgrp¶

Docstring¶

PyExample¶

Mux¶

Manual¶