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

0026992: Use Doxygen tag @ref for cross-references in documentation

Browse Source 
href have been replaced by @ref tags except for the links to web-pages and other documents where @ref tags do not work either.
This commit is contained in:
ysn
2015-12-18 15:33:23 +03:00
committed by bugmaster
parent 27245ff9c0
commit 67d7f07f51
10 changed files with 59 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
dox/dev_guides/contribution/coding_rules.md
View File

@@ -486,7 +486,7 @@ They should be detailed enough to allow any person to understand what each part
It is recommended to comment all static functions (like methods in headers), and to insert at least one comment per each 10-100 lines in the function body.
There are also some rules that define how comments should be formatted, see <a href="#occt_coding_rules_3">Formatting Rules</a>.
There are also some rules that define how comments should be formatted, see @ref occt_coding_rules_3 "Formatting Rules".
Following these rules is important for good comprehension of the comments. Moreover, this approach allows automatically generating user-oriented documentation directly from the commented sources.