Versions Compared

Old Version 3

changes.mady.by.user james

Saved on

compared with

New Version Current

changes.mady.by.user Henry Kwong

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


 

Doxygen is an automated documentation system for available Classes and methods. This page will introduce you to navigating the online Doxygen pages and orientate you to the structure and language used. 

Table of Contents

Doxygen Navigation 

...




  

Doxygen Hompage

The doxygen homepage gives a top level view of the class groupings and the most popular OpenSim and SimTK classes. From the homepage you can navigate down the Class hierarchy by clicking on blocks that correspond to the Classes that interest you.

The search box, located in the top right hand corner, searches through the matching Class names. This is useful if you know the class name but can be limiting if you are trying to discover Classes or methods. If you are trying to discover a method to use we suggest using the OpenSim omnisearch box, which searches through all the OpenSim confluence, forum and doxygen content.  

 



Class Lists

The left hand navigation panel is used move through Class lists, Class Hierachy and Class Members. The flat and hierarchical Class lists show all of the API classes and give you the opportunity to discover new Classes.

 

 

 

...





Parts of the Doxygen Page

...