OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-09-18 14:27:39 +03:00
Code Activity

0028654: Existed tool (gendoc) for generation documentation does not take into account size of images.

Browse Source 
The parameter defining image width has been added to all figures to improve their layout in PDF documents and tweaked depending on the nature of each image.
Additionally, some minor changes improving image and text layout have been introduced.

Remove temporary added possibility for setting image width automatically for generation of pdf documentation.
This commit is contained in:
ysn
2017-06-02 11:55:34 +03:00
committed by bugmaster
parent 26e0b3353c
commit d6b4d3d0d5
20 changed files with 478 additions and 562 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
dox/user_guides/foundation_classes/foundation_classes.md
View File

@@ -111,7 +111,7 @@ Data types described in a package may include one or more of the following data
* Pointers to other object classes
Inside a package, two data types cannot bear the same name.
@figure{/user_guides/foundation_classes/images/foundation_classes_image003.png, "Contents of a package"}
@figure{/user_guides/foundation_classes/images/foundation_classes_image003.png,"Contents of a package",420}
**Methods** are either **functions** or **procedures**. Functions return an object, whereas procedures only communicate by passing arguments. In both cases, when the transmitted object is an instance manipulated by a handle, its identifier is passed. There are three categories of methods:
* **Object constructor** Creates an instance of the described class. A class will have one or more object constructors with various different arguments or none.
@@ -142,7 +142,7 @@ The data types in Open CASCADE Technology fall into two categories:
* Data types manipulated by handle (or reference)
* Data types manipulated by value
@figure{/user_guides/foundation_classes/images/foundation_classes_image004.png, "Manipulation of data types"}
@figure{/user_guides/foundation_classes/images/foundation_classes_image004.png,"Manipulation of data types",420}
A data type is implemented as a class. The class not only defines its data representation and the methods available on instances, but it also suggests how the instance will be manipulated.
* A variable of a type manipulated by value contains the instance itself.
@@ -211,13 +211,13 @@ There are three categories of types which are manipulated by value:
* Types defined by classes not inheriting from *Standard_Transient*, whether directly or not.
Types which are manipulated by value behave in a more direct fashion than those manipulated by handle and thus can be expected to perform operations faster, but they cannot be stored independently in a file.
@figure{/user_guides/foundation_classes/images/foundation_classes_image005.png, "Manipulation of a data type by value"}
@figure{/user_guides/foundation_classes/images/foundation_classes_image005.png,"Manipulation of a data type by value",420}
@subsubsection occt_fcug_2_1_3 Types manipulated by reference (handle)
These are types defined by classes inheriting from the *Transient* class.
@figure{/user_guides/foundation_classes/images/foundation_classes_image006.png, "Manipulation of a data type by reference"}
@figure{/user_guides/foundation_classes/images/foundation_classes_image006.png,"Manipulation of a data type by reference",420}
@subsubsection occt_fcug_2_1_4 When is it necessary to use a handle?
@@ -1910,3 +1910,4 @@ This is reasonable precision to pass to an Intersection process as a limit of r
This is a reasonable precision to pass to an approximation process as a limit of refinement of fitting. The approximation is greater than the other precisions because it is designed to be used when the time is at a premium. It has been provided as a reasonable compromise by the designers of the Approximation algorithm. The current value is *Confusion() * 10*.
Note that Approximation is greater than Confusion, so care must be taken when using Confusion in an approximation process.