]> OCCT Git - occt.git/commitdiff
33343: Documentation, Overview - Incorrect doxygen syntax
authorbtokarev <btokarev@opencascade.com>
Mon, 19 Jun 2023 14:41:36 +0000 (15:41 +0100)
committervglukhik <vglukhik@opencascade.com>
Fri, 21 Jul 2023 15:33:50 +0000 (16:33 +0100)
Removed inclusions of empathized *text* from the titles
Text empathizers re-implemented
Reverted to no empathize style

dox/contribution/coding_rules.md
dox/user_guides/draw_test_harness/draw_test_harness.md

index c8f9a37ea9e43a5b621eb8145b513ec69a17dadb..70e151f020ea9c66a52a7ff58b561a6fefdcce36 100644 (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.
 
-### Use *sizeof()* to calculate sizes [MANDATORY]
+### Use sizeof() to calculate sizes [MANDATORY]
 
 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.
 
-### 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.
 
@@ -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.
 
-### Match *new* and *delete* [MANDATORY]
+### Match new and delete [MANDATORY]
 
 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.
 
-### Do not hide global *new*
+### Do not hide global new
 
 Avoid hiding the global *new* operator.
 
index c25975a4dba300e4e2489b68f61e2c73f60077fe..faf18d81f4e08d23381fe0d048f4fe43803d39eb 100644 (file)
@@ -780,7 +780,7 @@ restore theBox
 
 @subsubsection occt_draw_3_3_1 set
 
-#### In *DrawTrSurf* package:
+#### In DrawTrSurf package:
 
 ~~~~{.php}
 void Set(Standard_CString& Name,const gp_Pnt& G) ; 
@@ -797,7 +797,7 @@ void Set(Standard_CString& Name,
 const Handle(Poly_Polygon2D)& P) ; 
 ~~~~
 
-#### In *DBRep* package:
+#### In DBRep package:
 
 ~~~~{.php}
 void Set(const Standard_CString Name, 
@@ -822,13 +822,13 @@ DBRep::Set(char*,B);
 
 @subsubsection occt_draw_3_3_2 get
 
-#### In *DrawTrSurf* package:
+#### In DrawTrSurf package:
  
 ~~~~{.php}
 Handle_Geom_Geometry Get(Standard_CString& Name) ; 
 ~~~~
 
-#### In *DBRep* package:
+#### In DBRep package:
 
 ~~~~{.php}
 TopoDS_Shape Get(Standard_CString& Name,