update generation info and mention that you need doxygen >= 1.5.4 to correctly regen wx docs
git-svn-id: https://svn.wxwidgets.org/svn/wx/wxWidgets/trunk@52545 c3d73ce0-8a6f-49c7-b76d-6d57e0e08775
This commit is contained in:
@@ -33,14 +33,22 @@ 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 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
|
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
|
Important Dos and Don'ts
|
||||||
|
Reference in New Issue
Block a user