Introduction to Open CASCADE documentation

 

The constant growth and improvement of such a complex software as Open CASCADE development platform makes maintenance of its reference documentation in up-to-date and consistent state a very complicated and time-consuming task. Seeking for balance between user-friendliness and description exhaustiveness Open CASCADE S.A.S. decided to stop the maintenance of reference documentation in hlp and htm file formats created manually with RoboHelp ®. Starting from OCCT 6.1 minor release, the reference documentation is supported on the level of cdl (Class Description Language) and hxx files and generated by  Doxygen software.

This document is just an introduction to Open CASCADE Technology dealing with compatibility and installation issues and providing a general description of Open CASCADE modules and other features. All modules and development tools are described in User's Guides, available in Adobe Portable Document Format (PDF). To read this format, you need Adobe Acrobat Reader, which is a freeware and can be downloaded from the Adobe site. All user guides can be accessed directly from this help.

Alongside with PDF User Guides, Open CASCADE suggests its users full reference documentation on all implementation classes automatically generated by Doxygen software. This Doxygen generated documentation is supplied  in the form of a separate package, in a usual html file format.

Reference documentation is presented in Modules --> Toolkits -->  Packages --> Classes  OCC logic structure.

 

You can generate OCCT documentation with Doxygen yourself using WOK. To do this:

1. Set TMP environment variable.

2. Launch WOK session, go to the necessary workbench .

3. Input DocGenerate <Module or Toolkit name> <output folder>

NB. Doxygen can not be compiled and thus does not work on Solaris 2.6, it works on Windows, Linux and Solaris 2.8.