OpenCascade/occt
1
0
Fork 0
mirror of https://git.dev.opencascade.org/repos/occt.git synced 2025-04-04 18:06:22 +03:00
Code Packages Releases Activity

33343: Documentation, Overview - Incorrect doxygen syntax

Browse Source 
Removed inclusions of empathized *text* from the titles
Text empathizers re-implemented
Reverted to no empathize style
This commit is contained in:
btokarev 2023-06-19 15:41:36 +01:00 committed by vglukhik
parent 99559ae7d7
commit f81b1b56f5
2 changed files with 8 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
dox/contribution/coding_rules.md
View File

@ -725,7 +725,7 @@ Another possible problem is the order of initialization of global variables defi
Avoid explicit usage of basic types (*int*, *float*, *double*, etc.), use Open CASCADE Technology types from package *Standard: Standard_Integer, Standard_Real, Standard_ShortReal, Standard_Boolean, Standard_CString* and others or a specific *typedef* instead. Avoid explicit usage of basic types (*int*, *float*, *double*, etc.), use Open CASCADE Technology types from package *Standard: Standard_Integer, Standard_Real, Standard_ShortReal, Standard_Boolean, Standard_CString* and others or a specific *typedef* instead.
### Use *sizeof()* to calculate sizes [MANDATORY] ### Use sizeof() to calculate sizes [MANDATORY]
Do not assume sizes of types. Use *sizeof()* instead to calculate sizes. Do not assume sizes of types. Use *sizeof()* instead to calculate sizes.
@ -738,7 +738,7 @@ It is recommended to follow this rule for any plain text files for consistency a
The rules listed in this chapter are important for stability of the programs that use Open CASCADE Technology libraries. The rules listed in this chapter are important for stability of the programs that use Open CASCADE Technology libraries.
### Use *OSD::SetSignal()* to catch exceptions ### Use OSD::SetSignal() to catch exceptions
When using Open CASCADE Technology in an application, call *OSD::SetSignal()* function when the application is initialized. When using Open CASCADE Technology in an application, call *OSD::SetSignal()* function when the application is initialized.
@ -787,7 +787,7 @@ See the following example:
In C++ use *new* and *delete* operators instead of *malloc()* and *free()*. Try not to mix different memory allocation techniques. In C++ use *new* and *delete* operators instead of *malloc()* and *free()*. Try not to mix different memory allocation techniques.
### Match *new* and *delete* [MANDATORY] ### Match new and delete [MANDATORY]
Use the same form of new and delete. Use the same form of new and delete.
@ -812,7 +812,7 @@ Standard_Integer aTmpVar2 = 0; // OK
Uninitialized variables might be kept only within performance-sensitive code blocks and only when their initialization is guaranteed by subsequent code. Uninitialized variables might be kept only within performance-sensitive code blocks and only when their initialization is guaranteed by subsequent code.
### Do not hide global *new* ### Do not hide global new
Avoid hiding the global *new* operator. Avoid hiding the global *new* operator.

8
dox/user_guides/draw_test_harness/draw_test_harness.md
View File

@ -780,7 +780,7 @@ restore theBox
@subsubsection occt_draw_3_3_1 set @subsubsection occt_draw_3_3_1 set
#### In *DrawTrSurf* package: #### In DrawTrSurf package:
~~~~{.php} ~~~~{.php}
void Set(Standard_CString& Name,const gp_Pnt& G) ; void Set(Standard_CString& Name,const gp_Pnt& G) ;
@ -797,7 +797,7 @@ void Set(Standard_CString& Name,
const Handle(Poly_Polygon2D)& P) ; const Handle(Poly_Polygon2D)& P) ;
~~~~ ~~~~
#### In *DBRep* package: #### In DBRep package:
~~~~{.php} ~~~~{.php}
void Set(const Standard_CString Name, void Set(const Standard_CString Name,
@ -822,13 +822,13 @@ DBRep::Set(char*,B);
@subsubsection occt_draw_3_3_2 get @subsubsection occt_draw_3_3_2 get
#### In *DrawTrSurf* package: #### In DrawTrSurf package:
~~~~{.php} ~~~~{.php}
Handle_Geom_Geometry Get(Standard_CString& Name) ; Handle_Geom_Geometry Get(Standard_CString& Name) ;
~~~~ ~~~~
#### In *DBRep* package: #### In DBRep package:
~~~~{.php} ~~~~{.php}
TopoDS_Shape Get(Standard_CString& Name, TopoDS_Shape Get(Standard_CString& Name,