CppDoc Example Documentation

home download screen shots bugs mailing list example output generated MFC docs help tools and utilities

Overview

Project

Class

Tree

Deprecated

Index

CppDoc Example Documentation

FRAMES NO FRAMES

SUMMARY: INNER | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

Code
Class Bar

in Bar.h

Another class, to demonstrate some more stuff.

Inner Classes, Typedefs, and Enums
`enum`	`Bar::Mood` You can document enums and other such beasts.
`typedef`	`Bar::RandomFuncPtr` CppDoc won't get confused by all but the most gut-wrenching declarations.

Method Summary
`void`	`doSomethingStrange( Bar::RandomFuncPtr ptr, int ) const` CppDoc will cross-reference whatever it can.
`protected Foo`	`getFoo() const` A protected member that returns an object.
`int`	`weirdFunc( bool arg )` #defines are OK.

Method Detail

public void doSomethingStrange( Bar::RandomFuncPtr ptr, int ) const;

CppDoc will cross-reference whatever it can. Note that RandomFuncPtr is a link.

protected Foo getFoo() const;

A protected member that returns an object.

public int weirdFunc( bool arg );

#defines are OK. CppDoc will handle preprocessor macros as well as #ifdef, #ifndef, etc.