cppdoc_test
Class TestDoc

TestDocBase
   |
   +--TestDoc

Direct Known Subclasses:

MultipleInheritance, TestDocDerived

class TestDoc

extends TestDocBase

Class for documentation testing. Some inline stuff is to follow.
The document root path is: ../../..
Here are the source files:

• TestDoc.cpp
• TestDoc.h

Since:

version 1.0

See Also:

"The help file", getStr, Code.Foo, the CppDoc website

TestDoc

public TestDoc( long x );

A constructor.

~TestDoc

public virtual ~TestDoc();

The destructor. This comment came from the .cpp file (TestDoc.h).

bar

public void bar();

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

See Also:

getStr, someDeprecatedMethod

getStr

public String getStr( int x, float y ) throw( TestDocException );

A test function to show off the @param tag. Note that the throw specification in the function declaration is not required for the @throw tag.

Parameters:

x - the first parameter... which isn't used

y - another unused parameter

Returns:

the String "hi"

Throws:

TestDocException - when anything bad happens

plainOlFunc

protected int plainOlFunc();

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

someDeprecatedMethod

public void someDeprecatedMethod();

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

This is some documentation attached to a deprecated method.

someStaticFunc

protected static float someStaticFunc( int* arg );

A static method.