Specific Examples Test Suite¶
Template Type Alias¶
Typedef Examples¶
-
class
TestClass
¶
-
class
TypeDefTest
¶
-
file
typedef.h
Namespaced Function Examples¶
-
virtual void
testnamespace::NamespacedClassTest
::
function
() const = 0¶ namespaced class function
-
inline void
testnamespace::ClassTest
::
function
()¶ second namespaced class function
-
inline void
testnamespace::ClassTest
::
anotherFunction
()¶ second namespaced class other function
-
void
ClassTest
::
function
(int myParameter)¶ non-namespaced class function
More details in the header file.
More documentation in the impl file
-
void
ClassTest
::
anotherFunction
()¶ non-namespaced class other function
More documentation in the impl file
Extern Examples¶
-
int
cache_tree_matches_traversal
(struct cache_tree*, struct name_entry *ent, struct traverse_info *info)¶
-
struct cache_tree
global_cache_tree
¶ Shared cache tree instance.
Alias Example¶
-
void
frob_foos
(void *Frobs) Foo frob routine.
- bob this something else
- Side Effects\n Frobs any foos.
- bob this something else
- Side Effects\n Frobs any foos.
- Parameters
Frobs – any foos.
- Returns
Frobs any foos.
Fixed Width Font¶
-
class
Out
¶
Function Overloads¶
-
void
f
(int, int)¶ Function which takes two int arguments.
-
void
f
(double, double)¶ Function which takes two double arguments.
-
void
test
::
g
(int, int)¶ Another function which takes two int arguments.
-
void
test
::
g
(double, double)¶ Another function which takes two double arguments.
-
void
h
(std::string, MyType)¶ Another function which takes a custom type.
-
void
h
(std::string, MyOtherType o)¶ Another function which takes another custom type.
-
void
h
(std::string, const int myint)¶ Another function which takes a const basic type.
Program Listing¶
-
Vector
center
() const¶ The center of the InteractionBox in device coordinates (millimeters). This point is equidistant from all sides of the box.
Vector boxCenter = interactionBox.center(); Vector max = interactionBox.max(); Vector diff = max - boxCenter;
- Since
1.0
- Returns
The InteractionBox center in device coordinates.
Image¶
-
class
ImageClass
: public Image¶ This is a class with an image in the description.
It renders like this:
Breathe & Sphinx should automatically copy the image from the doxygen output directory into the _images folder of the Sphinx output.
Array Parameter¶
-
int
foo
(int a[5])¶ My function.
-
int
bar
(int n, int a[static n])¶ My other function.
C Struct¶
C Union¶
C Enum¶
-
enum
GSM_BackupFormat
¶ Backup data.
Values:
-
enumerator
GSM_Backup_Auto
¶ Compatibility with old gboolean used instead of format.
File type is guessed for extension, non unicode format used for Gammu backup.
-
enumerator
GSM_Backup_AutoUnicode
¶ Compatibility with old gboolean used instead of format.
File type is guessed for extension, unicode format used for Gammu backup.
-
enumerator
GSM_Backup_LMB
¶ LMB format, compatible with Logo manager, can store phonebooks and logos.
-
enumerator
GSM_Backup_VCalendar
¶ vCalendar standard, can store todo and calendar entries.
-
enumerator
GSM_Backup_VCard
¶ vCard standard, can store phone phonebook entries.
-
enumerator
GSM_Backup_LDIF
¶ LDIF (LDAP Data Interchange Format), can store phone phonebook entries.
-
enumerator
GSM_Backup_ICS
¶ iCalendar standard, can store todo and calendar entries.
-
enumerator
GSM_Backup_Gammu
¶ Gammu own format can store almost anything from phone.
This is ASCII version of the format, Unicode strings are HEX encoded. Use GSM_Backup_GammuUCS2 instead if possible.
-
enumerator
GSM_Backup_GammuUCS2
¶ Gammu own format can store almost anything from phone.
This is UCS2-BE version of the format.
-
enumerator
GSM_Backup_VNote
¶ vNote standard, can store phone notes.
-
enumerator
C Typedef¶
C Macro¶
C++ Macro¶
Multifile¶
Interface Class¶
-
interface
InterfaceClass
¶ This is a test interface class.
Some details about the InterfaceClass interface
C++ Anonymous Entities¶
-
struct
ClassWithAnonEntities
¶ -
Public Members
-
int
structMember
¶
-
struct ClassWithAnonEntities::[anonymous] [anonymous]¶
-
int
unionMember
¶
-
union ClassWithAnonEntities::[anonymous] [anonymous]¶
-
int
C++ Union¶
C++ Enums¶
C++ Functions¶
C++ Friend Classes¶
-
struct
A
¶
-
struct
B
¶
-
struct
C
¶ Friends
- friend class A
- friend struct B
C++ Inherited Members¶
-
class
Base
¶ - #include <cpp_inherited_members.h>
Base class.
Public Functions
-
void
f_issue_356
()¶ Base-class member function.
-
void
C++ Trailing Return Type¶
Functions
-
auto
f_issue_441
() -> Thingy*¶ Function that creates a thingy.
C++ Constexpr Handling¶
Test for issue 717.
C++ Function Lookup¶
-
void
fNoexcept
() noexcept¶
-
void
fFinal
() final¶
-
void
fOverride
() override¶
This one should actually have [[myattr]]
but Doxygen seems to not put attributes into the XML:
-
void
fAttr
()¶
-
void
fFInit
() = default¶
-
auto
fTrailing
() -> int¶
-
void
fInit
(int arg = 42)¶
-
void
fPlain
(int arg)¶
-
void
fPtr
(int *arg)¶
-
void
fLRef
(int &arg)¶
-
void
fRRef
(int &&arg)¶
-
void
fMemPtr
(int A::* arg)¶
-
void
fParen
(void (*arg)())¶
-
void
fParenPlain
(void (*arg)(int argInner))¶
Doxygen xrefsect¶
A few examples of xrefsect items support.
Functions
-
int
unimplemented
(void)¶ An example of using Doxygen’s todo command.
- Todo:
Implement this function.
-
void
buggy_function
(int param)¶ An example of using Doxygen’s bug and test commands.
- Bug:
Does not work yet.
- Test:
Add proper unit testing first.
-
void
old_function
(void)¶ An example of using Doxygen’s deprecated command.
- Deprecated:
Should not be used on new code.
-
void
sample_xrefitem_function
(void)¶ An example of a custom Doxygen xrefitem declared as an ALIAS.
- xref Sample:
This text shows up in the xref output.