1
0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-08-09 13:22:24 +03:00

0024269: Content of occt documentation should be formated

building subsection introduced; wok moved to dev guides section;
Requirements and Installation sections were interchanged;
some Unicode characters removed from .md files; \DeclareUnicodeCharacter{00A0}{ } instruction added into refman file
images insertion rolled back to dual html,latex insertion; mainpage now is processed (index.tex);
surplus part of overview has been removed
foundation_classes.md and technical_overview.md updated;
Reviewed step, tobj, xde and partly iges; Corrections in other guides.
Overview installation and requirements changes updated
This commit is contained in:
ysn
2013-11-01 16:47:47 +04:00
committed by bugmaster
parent 4df5470212
commit dba69de2f0
54 changed files with 9258 additions and 9667 deletions

View File

@@ -1,7 +1,7 @@
Developer Guides {#dev_guides}
================
@section OCCT_OVW_SECTION1 Source Repository
## Source Repository
This directory contains sources of Open CASCADE Technology (OCCT), a collection
of C++ libraries providing services for 3D surface and solid modeling, CAD data
@@ -15,39 +15,7 @@ compliance with the License. Please see the LICENSE file or obtain a copy of the
License at http://www.opencascade.org and read it completely before using this
software.
@section OCCT_OVW_SECTION11 Building OCCT Libraries
The source package of the Open CASCADE Technology including the source files of samples
and tools and the set of building procedures is available for self-dependent preparation
binary files on UNIX and Windows platforms.
In order to build OCCT libraries from these sources for use in your program,
you need to:
1. Install the required third-party libraries.
Follow the instructions provided in the documents titled "Building 3rd party
products for OCCT" on http://dev.opencascade.org/?q=home/resources for
choice of the needed libraries, their installation and building.
2. If you use OCCT sources from Git repository or do come changes affecting
CDL files or dependencies of OCCT toolkit, update header files generated
from CDL, and regenerate build scripts for your environment using WOK.
See \subpage dev_guides__wok "WOK" for details.
Skip to step 3 if you use complete source package (e.g. official OCCT
release) without changes in CDL.
3. Build using your preferred build tool.
- \subpage dev_guides__building__automake "Building on Linux with Autotools"
- \subpage dev_guides__building__cmake "Building with CMake (cross-platform)"
- \subpage dev_guides__building__code_blocks "Building on Mac OS X with Code::Blocks"
- \subpage dev_guides__building__msvc "Building on Windows with MS Visual Studio 2005-2012"
- \subpage dev_guides__building__xcode "Building on Mac OS X with Xcode"
The current version of OCCT can be consulted in the file src/Standard/Standard_Version.hxx
@section OCCT_OVW_SECTION111 Automatic tests
## Automatic tests
OCCT automatic testing system is integrated with @ref draw "DRAW Test Harness",
a console application based on Tcl (a scripting language).
@@ -88,15 +56,24 @@ To see intermediate commands and their output during the test execution,
add one more argument '-echo' at the end of the command line, or type 'dlog get'
after test completion.
For more information consult \subpage dev_guides__tests "Automatic Testing System"
For more information consult \subpage dev_guides__tests
@section OCCT_OVW_SECTION1112 CDL Overview
## docs
**short description**
CDL is the component definition language of the Open CASCADE Technology (OCCT) programming platform.
Some components, which CDL allows you to create, are specific to OCCT application architecture.
\subpage dev_guides__documentation
For more information consult \subpage dev_guides__cdl "Component Definition Language Developer's Guide"
## wok
**short description**
@section OCCT_OVW_SECTION1113 Documentation Overview
\subpage dev_guides__wok
\subpage dev_guides__documentation "Documentation Developer's Guide"
## building
**short description**
\subpage dev_guides__building
## cdl
**short description**
\subpage dev_guides__cdl