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

Merge branch 'doxygen_update' of https://github.com/a-wi/wxWidgets

Browse Source 
Update instructions for using Doxygen.

See https://github.com/wxWidgets/wxWidgets/pull/1325
This commit is contained in:
Vadim Zeitlin
2019-05-18 14:14:57 +02:00
parent 357108d3cd 1965ca4296
commit a120673849
1 changed files with 4 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -33,8 +33,9 @@ which are implementation details.
Running Doxygen Running Doxygen
--------------- ---------------
First, make sure you have a recent version of Doxygen installed in your system First, make sure you have a recent version of Doxygen (currently Doxygen 1.8.8
(currently Doxygen 1.8.8 is used). is used) and Graphviz installed in your system (under Windows Graphviz
location should be in %PATH%).
On Unix: On Unix:
@@ -63,7 +64,7 @@ DO:
- strive to use dedicated Doxygen commands for e.g. notes, lists, - strive to use dedicated Doxygen commands for e.g. notes, lists,
sections, etc. The "Special commands" page: sections, etc. The "Special commands" page:
http://www.stack.nl/~dimitri/doxygen/commands.html http://www.doxygen.org/manual/commands.html
is your friend! is your friend!
It's also very important to make a consistent use of the ALIASES It's also very important to make a consistent use of the ALIASES
defined by wxWidgets' Doxyfile. Open that file for more info. defined by wxWidgets' Doxyfile. Open that file for more info.