Skip to content

Commit

Permalink
33343: Documentation, Overview - Incorrect doxygen syntax
Browse files Browse the repository at this point in the history
Removed inclusions of empathized *text* from the titles
Text empathizers re-implemented
Reverted to no empathize style
  • Loading branch information
btokarev authored and vglukhik committed Jul 21, 2023
1 parent 99559ae commit f81b1b5
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 8 deletions.
8 changes: 4 additions & 4 deletions dox/contribution/coding_rules.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.

Expand Down Expand Up @@ -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.

Expand All @@ -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.

Expand Down
8 changes: 4 additions & 4 deletions dox/user_guides/draw_test_harness/draw_test_harness.md
Original file line number Diff line number Diff line change
Expand Up @@ -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) ;
Expand All @@ -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,
Expand All @@ -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,
Expand Down

0 comments on commit f81b1b5

Please sign in to comment.