Homepage
Overview
Downloads

Documentation

Credits


Tekkotsu Source Documentation

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!

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.

Documentation Contents:

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.

You can regenerate a local copy of these pages if you install the doxygen package.  A nice reason to do this is you can build a searchable database to run on your local web server.  This file is found at docs/index.html, which overwrites the doxygen generated page.







Last Modified: $Date: 2003/02/24 10:35:06 $ GMT