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

update generation info and mention that you need doxygen >= 1.5.4 to correctly regen wx docs

Browse Source 
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52545 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
Francesco Montorsi
2008-03-15 12:26:44 +00:00
parent 3d6c68c1c9
commit 6a70b5f1b9
1 changed files with 12 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/tech/tn0003.txt
View File

@@ -33,14 +33,22 @@ which are implementation details.
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 installed in your system
(you'll need Doxygen >= 1.5.4).
For HTML:
On Unix:
1) run wxWidgets/docs/doxygen/regen.sh [format-to-generate]
On Windows:
1) cd wxWidgets/docs/doxygen
2) run ./regen.sh [Unix] or regen.bat [Windows]
2) run regen.bat [format-to-generate]
[TODO: instructions for generation of other formats]
If you don't specify which format to [re]generate, all output formats will
be enabled. Possible values for [format-to-generate] are: "html", "chm", "latex",
"xml" and "all".
The output of Doxygen is all placed in the wxWidgets/docs/doxygen/out folder.
Important Dos and Don'ts