mirror of
https://git.dev.opencascade.org/repos/occt.git
synced 2025-08-14 13:30:48 +03:00
0024722: Move functionality of WOK command wgendoc to OCCT tool gendoc
Command gendoc improved to: - generate Reference Manual documentation (OCCT classes reference) with option -refman; option -overview can be used for generation of overview documentation; - generate PDF documents for all User Guides automatically (for files listed in FILES_PDF.txt); - check availability of third-party tools (Doxygen, Inkscape etc.) and properly report warnings and errors. - use templates of configuration files for third-party tools instead of their generation. These template files are located in dox/resources folder Tcl scripts are moved from dox folder to adm. Doxygen warnings are eliminated. Moved all auxilary functions to occaux.tcl. Fixed Reference manual generation on *nix platform. Fixed PDF generation on *nix platforms.
This commit is contained in:
@@ -1,4 +1,4 @@
|
||||
Coding Rules {#dev_guides__coding_rules}
|
||||
Coding Rules {#occt_dev_guides__coding_rules}
|
||||
======================================
|
||||
|
||||
@tableofcontents
|
||||
@@ -238,7 +238,7 @@ Prefer C++ style comments in C++ sources.
|
||||
|
||||
### Commenting out unused code
|
||||
|
||||
Delete unused code instead of commenting it or using #define.
|
||||
Delete unused code instead of commenting it or using \#define.
|
||||
|
||||
### Indentation in sources [MANDATORY]
|
||||
|
||||
@@ -541,7 +541,7 @@ Use *private* fields if future extensions should be disabled.
|
||||
|
||||
### Constants and inlines over defines [MANDATORY]
|
||||
|
||||
Use constant variables (const) and inline functions instead of defines (#define).
|
||||
Use constant variables (const) and inline functions instead of defines (\#define).
|
||||
|
||||
### Avoid explicit numerical values [MANDATORY]
|
||||
|
||||
|
Reference in New Issue
Block a user