From 6a70b5f1b9f3768a4d0e130279b9bbfe78558673 Mon Sep 17 00:00:00 2001 From: Francesco Montorsi Date: Sat, 15 Mar 2008 12:26:44 +0000 Subject: [PATCH] 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 --- docs/tech/tn0003.txt | 16 ++++++++++++---- 1 file changed, 12 insertions(+), 4 deletions(-) diff --git a/docs/tech/tn0003.txt b/docs/tech/tn0003.txt index 569a3467a2..180b193e1f 100644 --- a/docs/tech/tn0003.txt +++ b/docs/tech/tn0003.txt @@ -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] + +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". -[TODO: instructions for generation of other formats] +The output of Doxygen is all placed in the wxWidgets/docs/doxygen/out folder. Important Dos and Don'ts -- 2.45.2