Frames | No Frames

Documentation Contents:

If you want a more general overview of what this software does and how the pieces fit together, you may want to visit the overview.

• Namespace List - Lists the global namespaces
• Class Hierarchy - Lists all classes and structs, grouped by inheritance
• Alphabetical Index - Lists all classes and structs alphabetically
• Compound List - Lists all classes and structs alphabetically, gives a short description
• File List - Lists all source code files, gives a short description
• Namespace Members - Lists the members of all namespaces
• Compound Members - Lists the member functions and variables of all classes
• File Members - Lists the global variables and macros across all files
• Related Pages - Links to the todo and bug lists.

These documents will give you nitty-gritty details on the individual functions, classes, and data structures.  It is collated from comments embedded in the source code by doxygen.  Expect a few rough edges, this started life as an internal resource.  It's not that we don't know proper grammar, it's just that we'd rather be writing code. ;-)  If something is unclear, please feel free to drop us a line!

Documentation Download:

If you would like to obtain local static copies of the documentation, there are two formats:

• PDF (v1.4, X.XMB)
• HTML (v1.4 X.XMB)

External Documentation:

This code is originally based on an early version of CMU's 2002 Legged RoboSoccer entry, CMPack.  WalkMC and the CMVision library still fall under their license.  This license is also included in the files themselves.

Note that CMVision is not documented in this project.  There is some documentation as compressed postscript and PDF.