summaryrefslogtreecommitdiffstats
path: root/doc/install.doc
diff options
context:
space:
mode:
authorDimitri van Heesch <dimitri@stack.nl>2007-07-19 13:04:41 (GMT)
committerDimitri van Heesch <dimitri@stack.nl>2007-07-19 13:04:41 (GMT)
commit29a8f144739c86ffad8db2f0c09de66bb641d2e2 (patch)
tree7c115c97f09109f537a6eb50b9baa3c0cd91d07d /doc/install.doc
parent01147699a7fb267e9d9247bdfb640f46e2164d3a (diff)
downloadDoxygen-29a8f144739c86ffad8db2f0c09de66bb641d2e2.zip
Doxygen-29a8f144739c86ffad8db2f0c09de66bb641d2e2.tar.gz
Doxygen-29a8f144739c86ffad8db2f0c09de66bb641d2e2.tar.bz2
Release-1.5.2-20070719
Diffstat (limited to 'doc/install.doc')
-rw-r--r--doc/install.doc59
1 files changed, 40 insertions, 19 deletions
diff --git a/doc/install.doc b/doc/install.doc
index 3c75386..b8cb8ff 100644
--- a/doc/install.doc
+++ b/doc/install.doc
@@ -366,40 +366,61 @@ before running make.
\section install_src_windows Compiling from source on Windows
From version 1.5.0 onwards, build files are provided for Visual Studio 2005.
-Also the free "Express" version of Developer Studio can be used to compile doxygen.
-Alternatively, you can compile doxygen \ref install_src_unix "the Unix way" using
+Also the free (as in beer) "Express" version of Developer Studio can be used to
+compile doxygen. Alternatively, you can compile doxygen
+\ref install_src_unix "the Unix way" using
<a href="http://en.wikipedia.org/wiki/Cygwin">Cygwin</a>
or <a href="http://www.mingw.org/">MinGW</a>.
Before you can compile doxygen you need to download and install the C++ compiler of
Visual Studio. Since Microsoft apparently wants to lure everyone into using their
-.NET stuff, you need to
+.NET stuff, they made things somewhat difficult when you use the Express version.
+You need to
<a href="http://msdn.microsoft.com/vstudio/express/visualc/usingpsdk/">
do some manual steps</a> in order to setup a proper working environment for building
-native win32 applications.
-
-Once your environment is setup, you
-can <a href="http://www.stack.nl/~dimitri/doxygen/download.html#latestsrc">download</a>
-the source distribution of doxygen and unpack it.
-If you don't have a tool like WinZip, then I suggest to download
-<a href="http://sourceforge.net/projects/unxutils/">unxutils</a>
-and untar the archive from within a command box using
+native win32 applications such as Doxygen.
+
+The next step is to install unxutils (see http://sourceforge.net/projects/unxutils).
+This packages contains the tools \c flex and \c bison which are needed during the
+compilation process if you use a CVS snapshot of doxygen (the official source releases
+come with pre-generated sources).
+Download the zip extract it to e.g. <code>c:\\tools\\unxutils</code>.
+
+Now you need to add/adjust the following environment variables
+(via Control Panel/System/Advanced/Environment Variables):
+- add <code>c:\\tools\\unxutils\\usr\\local\\wbin;</code> to the start of <code>PATH</code>
+- set <code>BISON_SIMPLE</code> to <code>c:\\tools\\unxutils\\usr\\share\\bison.simple</code>
+
+Download doxygen's source tarball and put it somewhere (e.g use <code>c:\\tools</code>)
+
+Now start a new command shell and type
\verbatim
- tar zxvf doxygen-version.src.tar.gz
+cd c:\tools
+gunzip doxygen-x.y.z.src.tar.gz
+tar xvf doxygen-x.y.z.src.tar
\endverbatim
-Inside the archive you will find a \c winbuild directory containing a \c Doxygen.sln
-file. Just open this file in Visual Studio. You can now build the Doxygen, Doxytag,
-and Doxywizard projects for Release or Debug to compile the executables.
+to unpack the sources.
+
+Now your environment is setup to build \c doxygen and \c doxytag.
+
+Inside the \c doxygen-x.y.z directory you will find a \c winbuild directory
+containing a \c Doxygen.sln file. Open this file in Visual Studio.
+You can now build the Release or Debug flavor of Doxygen and Doxytag by right-clicking
+the project in the solutions explorer, and selecting Build.
-Note that compiling Doxywizard currently requires a <a href="http://www.trolltech.com/products/qt/qt3">
-commercial license for Qt 3</a>.
+Note that compiling Doxywizard currently requires Qt version 3
+(see http://www.trolltech.com/products/qt/qt3).
+If you do not have a commercial license, you can build Doxywizard with the open
+source version (see http://qtwin.sourceforge.net/qt3-win32/compile-msvc-2005.php),
+but I have not tried this myself.
-Also read the next section for additional tools you may need to install.
+Also read the next section for additional tools you may need to install to run
+doxygen with certain features enabled.
<!--
Currently, I have only compiled doxygen for Windows using Microsoft's
-Visual C++ (version 6.0). For other compilers you may need to edit the
+Visual C++ (). For other compilers you may need to edit the
perl script in <code>wintools/make.pl</code> a bit.
Let me know what you had to change if you got Doxygen working with another
compiler. If you have Visual Studio you can also use the .dsw file found in