The constant growth and improvement of such a complex software as Open CASCADE Technology 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 decided to stop the maintenance of reference documentation in .hlp and .html file formats created manually with RoboHelp® software.
Starting from OCCT 6.1 minor release documentation is composed of two parts:
1) Open CASCADE Technology Overview included into OCCT distribution package. RoboHelp® is now used only for the maintenance of this introduction to Open CASCADE Technology (in the HTML format) that deals with compatibility and installation issues and provides a general description of Open CASCADE modules and other features.
Besides, 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 website. All user guides can be accessed directly from this help.
2) Reference documentation is now supported on the level of .cdl (Class Description Language) and .hxx files and generated by DOXYGEN software, an open source documentation system.
This Doxygen generated documentation is supplied in the form of a separate package, in a usual .html file format. Documentation is generated by OCCT modules (OCAF, Foundation Classes, Visualization, etc.).
Doxygen documentation is much more convenient to the users since it contains all OCCT Class Hierarchy in text and graphic modes, description of classes, methods, functions, enumerations, variables and typedefs.
Inheritance relations between classes are represented by means of graphs.
Reference Documentation generated by Doxygen is not included into Open CASCADE Technology distribution (due to its considerable size) and can be additionally downloaded from:
OpenCASCADE Download Center
|
|
