A

anotherDeprecatedField - member variable in class TestDocException2

Deprecated. Just another test of deprecation for a field.

anotherFunc() - member function in class Foo

You can put documentation in the cpp file, too.

B

Bar - class in Code

Another class, to demonstrate some more stuff.

bar() - member function in class TestDoc

Here's a link: (Click Me!), and here's another link: getStr, and here's an unresolvable link: foo.

Bar::Mood - enum in Code

You can document enums and other such beasts.

Bar::RandomFuncPtr - typedef in Code

CppDoc won't get confused by all but the most gut-wrenching declarations.

baseField - member variable in class TestDocBase

C

ClassInSubProject - class in cppdoc_test.subproject

This class is in a subproject of cppdoc_test.

D

doNothing() - member function in class MultipleInheritance

Does nothing.

doSomethingStrange(RandomFuncPtr,int) - member function in class Bar

CppDoc will cross-reference whatever it can.

Down - field in enum Bar::Mood

F

Foo - class in Code

This is the Foo class.

Foo() - constructor in class Foo

The default constructor for Foo.

~Foo() - constructor in class Foo

Foo destructor.

Foo(const char*) - constructor in class Foo

Another constructor for Foo.

funk(int) - member function in class Foo

This is the function funk within the Foo class.

funk(int) - member function in class SpecificFoo

This is an override of funk in class Foo.

G

gCount - member variable in (cppdoc_test globals)

Here's a global variable, for good measure.

getFoo() - member function in class Bar

A protected member that returns an object.

getMessage() - member function in class TestDocException

getStr(int,float) - member function in class TestDoc

A test function to show off the @param tag.

H

hello() - member function in class ClassInSubProject

This function says hello.

M

main() - member function in (cppdoc_test globals)

The main function.

MultipleInheritance - class in cppdoc_test

Just a test of multiple inheritance.

MultipleInheritance() - constructor in class MultipleInheritance

P

plainOlFunc() - member function in class TestDoc

This is a plain ol' doc comment on a protected method.

protectedBaseMethod(int) - member function in class TestDocBase

publicBaseMethod() - member function in class TestDocBase

R

RandomFuncPtr - member variable in typedef Bar::RandomFuncPtr

S

Sideways - field in enum Bar::Mood

someDeprecatedField - member variable in class TestDocException2

Deprecated. Just testing deprecation for a field.

someDeprecatedMethod() - member function in class TestDoc

Deprecated. This method doesn't do anything. Use the bar() function instead.

someStaticFunc(int*) - static function in class TestDoc

A static method.

SpecificFoo - class in Code

A subclass of Foo.

String - class in cppdoc_test

String(const char*) - constructor in class String

SuperSpecificFoo - class in Code

A subclass of SpecificFoo.

T

TestDoc - class in cppdoc_test

Class for documentation testing.

~TestDoc() - constructor in class TestDoc

The destructor.

TestDoc(long) - constructor in class TestDoc

A constructor.

TestDocBase - class in cppdoc_test

TestDocBase() - constructor in class TestDocBase

~TestDocBase() - constructor in class TestDocBase

TestDocBase(int) - constructor in class TestDocBase

A protected constructor.

TestDocDerived - class in cppdoc_test

Just testing the third level of hierarchy.

TestDocException - class in cppdoc_test

TestDocException2 - class in cppdoc_test

Deprecated. This whole class is deprecated.

U

Up - field in enum Bar::Mood

W

weirdFunc(bool) - member function in class Bar

#defines are OK.

Y

yetAnotherFunc() - member function in class SuperSpecificFoo

This function doesn't do anything either.