mirror of
https://github.com/Open-Cascade-SAS/OCCT.git
synced 2026-05-10 01:20:50 +08:00
bec9558832
- Migration from dev.opencascade.org/Mantis/Gitolite infrastructure to GitHub-native workflow (Pull Requests, Issues, GitHub Actions CI/CD). - OCCT 8.0.0 upgrade guide with detailed notes on TCol* typedef deprecation, BSpline weight accessors, evaluation hierarchy refactoring (EvalD0/D1/D2/D3/DN), Handle out-parameter deprecation, Standard_Mutex → std::mutex, PLib value types, BRepGraph, TopoDS_TShape redesign, math wrapper deprecation, mesh factory registry, and more. - Build system modernization: C++17 requirement, VS2022/GCC8+/Clang7+ compilers, vcpkg integration, CMake-driven documentation targets replacing legacy gendoc. - Removed obsolete documentation: Mantis workflow, access levels, issue lifecycle, pre-7.1.0 upgrade history (archived at dev.opencascade.org/doc), in-tree Inspector and DFBrowser documentation, 3rd-party build guide (outsourced to vcpkg/upstream). - INSTALL_DIR_RESOURCE directory now correctly described in the install tree layout. - Obsolete BUILD_PATCH CMake option removed from documentation. - Code examples modernized: occ::handle<> syntax, NCollection_*<T> templates, BRepAdaptor_Curve, IsDone() checks, null-handle guards, native C++ types over Standard_* typedefs, Append() over Appends(), correct variable names. - Code block language tags: .php → .tcl for Tcl scripts, .glsl for shader listings. - IGES translator: deprecated API calls updated (SetReadVisible + TransferRoots), IDT_ message API replaced with Message_Messenger, thread-safety warning added. - DE_Wrapper: STEP thread-safety note (per-reader), IGES unsupported for concurrency. - Removed Mantis tracker link from GitHub issue template config. - Removed DFBROWSER and INSPECTOR entries from DrawPlugin resource file. - Tcl reference URL updated (tcl.tk → tcl-lang.org).
757 B
757 B
Build Documentation
To generate HTML documentation from sources contained in dox subdirectory, you need to have Doxygen 1.8.4 (or above) installed on your system. Tcl/Tk is required when configuring a full OCCT build with DRAW enabled.
OCCT documentation is generated via CMake targets. Enable -DBUILD_DOC_Overview=ON
when configuring the build, then build the desired target:
To generate Overview documentation:
cmake --build . --target Overview
To generate Reference manual:
cmake --build . --target RefMan
To generate all documentation:
cmake --build . --target doc
See @ref occt_contribution__documentation for prerequisites and details on OCCT documentation system.