cheng/wxWidgets
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix problems with documentation HOWTO syntax highlighting

Browse Source 
Use backticks to prevent "_" and "*" from being interpreted as special
Markdown characters.

No real changes.
This commit is contained in:
Vadim Zeitlin 2019-08-20 17:11:37 +02:00
parent 346d7c378d
commit fbe651731c
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/contributing/how-to-add-class-documentation.md
View File

@ -18,10 +18,10 @@ The documentation can then be added in form of Doxygen comments to
the header file. the header file.
You may also want to write a separate topic file, You may also want to write a separate topic file,
e.g. docs/doxygen/overviews/myclass.h, and add the entry to e.g. `docs/doxygen/overviews/myclass.h`, and add the entry to
docs/doxygen/mainpages/topics.h. `docs/doxygen/mainpages/topics.h`.
If applicable, also add an entry to one of the docs/doxygen/mainpages/cat_*.h If applicable, also add an entry to one of the `docs/doxygen/mainpages/cat_*.h`
files. files.
You can generate a first raw version of myclass.h simply taking its You can generate a first raw version of myclass.h simply taking its
@ -287,9 +287,9 @@ there is a corresponding link anchor.
The following conventions are used in wxWidgets doxygen comments: The following conventions are used in wxWidgets doxygen comments:
1. all "main" pages of the manual (those which are placed in 1. all "main" pages of the manual (those which are placed in
docs/doxygen/mainpages) have link anchors which begin with "page_" docs/doxygen/mainpages) have link anchors which begin with `page_`
2. all topic overviews (those which are placed in docs/doxygen/overviews) have 2. all topic overviews (those which are placed in docs/doxygen/overviews) have
link anchors which begin with "overview_" link anchors which begin with `overview_`
3. all @section, @subsection, @subsubsection tags should have as link anchor 3. all @section, @subsection, @subsubsection tags should have as link anchor
name the name of the parent section plus a specific word separated with an name the name of the parent section plus a specific word separated with an
underscore; e.g.: underscore; e.g.: