Introduction to Open CASCADE Technology documentation
This document is just an introduction to Open CASCADE Technology (OCCT) dealing with compatibility and installation issues and providing a general description of OCCT 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, OCCT 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 logic structure with cross-references to all OCCT classes and complete in-browser search by all classes.
Recommendation for generation of reference documentation
Reference documentation can be generated by OCCT binary WOK package that is available for downloading from www.opencascade.org and dev.opencascade.org sites.
Prerequisites:
Doxygen version 1.7.4 or higher
Graphviz version 2.28.0 or higher
Launch WOK.
wokcd “Your workbench”
source $env(WOKHOME)/lib/OS.tcl
source $env(WOKHOME)/lib/OCCTDocumentation.tcl
source $env(WOKHOME)/lib/OCCTGetVersion.tcl
OS -box
OCCDoc_GenerateDoc “Path to target folder“ {“list of modules”} {“Path to doxygen executable“} {“Path to doxygen executable“}
Sample :
OCCDoc_GenerateDoc W:/occt654/doc {FoundationClasses ModelingData ModelingAlgorithms Visualization ApplicationFramework DataExchange Draw} {W:/3rdpartyproducts/doxygen-1.8.0/bin} {W:/3rdpartyproducts/graphviz-2.28.0/bin}