Doxygen Test Suite¶
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.
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.
-
int
Func¶
-
class
Test6
¶ - #include <func.h>
Test6 class.
Details about Test6.
Public Functions
-
const char *
member
(char, int)¶ A member function.
- Return
a character pointer.
- Parameters
c
: a character.n
: an integer.
- Exceptions
std::out_of_range
: parameter is out of range.
-
const char *
-
file
func.h
Functions
-
void
myFunc
(int *a, int *b, int *c)¶ Doing important things with parameter directions.
- Parameters
[out] a
: output[in] b
: input[inout] c
: input but gets rewritten
-
void
Relates¶
-
file
relates.cpp
Author¶
Windows Nice Try.
- 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
Par¶
-
class
Test11
¶ 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
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.
-
void
-
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.
-
void
-
file
example.cpp
-
example
example_test.cpp
This is an example of how to use the Test5 class.More details about this example.
void main() { Test7 t; t.example(); }
Include¶
-
file
include.cpp
-
page
example
Our main function starts like this:
First we create a objectvoid main() {
t
of the Test7 class.Then we call the example member functionTest7 t;
After that our little test routine ends.t.example();
}
QtStyle¶
-
class
Test12
¶ A test class.
A more elaborate class description.
Public Types
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.
- Return
The test results
- See
- Parameters
a
: an integer argument.s
: a constant character pointer.
-
-
file
qtstyle.cpp
JdStyle¶
-
class
Test8
¶ A test class.
A more elaborate class description.
Public Types
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
- See
- See
- See
- Return
The test results
- Parameters
a
: an integer argument.s
: a constant character pointer.
-
-
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
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
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.
Enums
Variables
-
int
globVar
¶ A global variable.
-
ResTypeDef¶
-
struct
CoordStruct
¶ A coordinate pair.
-
file
restypedef.cpp
An example of resolving typedefs.
Typedefs
-
typedef CoordStruct
Coord
¶ Creates a type name for CoordStruct
-
typedef CoordStruct
AfterDoc¶
-
class
Test1
¶ - #include <afterdoc.h>
A test class
Public Types
Public Functions
-
void
member
()¶ a member function.
Protected Attributes
-
int
value
¶ an integer value
-
void
-
file
afterdoc.h
Template¶
-
template<class
T
, inti
= 100>
classTest14
¶ A template class
-
template<class
T
>
classTest14
<T*> : public Test14<void*, 200>¶ A partial template specialization
Public Functions
-
Test14
()¶
-
-
template<>
classTest14
<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.
-
void
-
file
tag.cpp
Group¶
-
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
-
group
group1
This is the first group.
More documentation for the first group.
-
group
group2
This is the second group.
-
group
group3
This is the third group.
-
group
group4
Group 4 is a subgroup of group 3.
-
group
group5
This is the fifth group.
-
page
mypage1
Text of the first section
-
page
mypage2
Text of the second section
Diagrams¶
-
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.
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.
-
void
-
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¶
-
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
Object
¶ Object type.
Base object class.
Subclassed by Vehicle
Public Functions
Private Members
-
int
ref
¶ Reference count.
-
int
-
file
manual.c
Functions
-
int
main
(void)¶ Main function.
Ref vehicleStart(), objRef(), objUnref().
-
int