[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    www/sites/developer/documentation/library
From:       Adriaan de Groot <groot () kde ! org>
Date:       2006-04-02 13:34:32
Message-ID: 1143984872.491177.5549.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 525567 by adridg:

Finish up the homebrew apidox documentation.

 M  +59 -3     howto.php  


--- trunk/www/sites/developer/documentation/library/howto.php #525566:525567
@@ -1279,14 +1279,14 @@
 within the installation path of KDE.
 If you have an SVN checkout, you need 
 <span class="file">doc/common/</span> inside the kdelibs checkout.
-Set the shell variable DOXDATADIR appropriately:
+Set the shell variable DOXDATA appropriately:
 
 
 <div class="shell">
   # For installed KDE
-$ DOXDATADIR=<i>/path/to/kde/</i>share/doc/HTML/en/common/
+$ DOXDATA=<i>/path/to/kde/</i>share/doc/HTML/en/common/
   # For SVN checkout
-$ DOXDATADIR=<i>/path/to/checkout/kdelibs/</i>doc/common/
+$ DOXDATA=<i>/path/to/checkout/kdelibs/</i>doc/common/
 </div>
 </li>
 
@@ -1309,6 +1309,62 @@
 $ QTDOCTAG=<i>/path/to/qt.tag</i>
 </div>
 </li>
+
+<li>
+Next, you need to ensure that references to Qt classes go to
+the right place. You can point them to the external documentation
+on Trolltech's website, or to your locally installed
+Qt documentation (assuming you have any).
+Do that by setting the QTDOCPATH variable:
+<div class="shell">
+  # For reference to the Qt 3.3 documentation on the web
+$ QTDOCPATH=http://doc.trolltech.com/3.3/
+  # For reference to the Qt 4.1 documentation on the web
+$ QTDOCPATH=http://doc.trolltech.com/4.1/
+  # For reference to locally installed documentation
+$ QTDOCPATH=<i>/path/to/doc/qt/html</i>
+</div>
+</li>
+
+<li>
+Finally, you need to know where your source checkout 
+lives for which you want to generate APIDOX.
+This should be a checkout of an <em>entire</em> SVN module.
+It should contain an <span class="file">admin/</span>
+directory at the top.
+Set the path to the source directory in the shell:
+<div class="shell">
+$ SRC=<i>/path/to/module/checkout/</i>
+</div>
+</li>
+
+<li>
+Now that you have collected all the information,
+all that remains is to build the APIDOX by running
+the <span class="cmd">doxygen.sh</span> script.
+Export the variables you have set, and call
+the script to build the APIDOX in the current directory
+(independently of the source directory).
+<div class="shell">
+$ export QTDOCPATH QTDOCTAG DOXDATA
+$ $SRC/admin/doxygen.sh $SRC
+</div>
+</li>
+
 </ol>
 
+<p>
+On my own system where I compile KDE 3.5, 
+I use the following settings:
+</p>
+
+<div class="shell">
+$ QTDOCTAG=/tmp/qt.tag
+$ QTDOCPATH=http://doc.trolltech.com/3.3/
+$ DOXDATADIR=/usr/local/kde-3.5/share/doc/HTML/en/common/
+$ SRC=/mnt/src/kde-3.5/kdebase
+$ export QTDOCPATH QTDOCTAG DOXDATADIR
+$ sh $SRC/admin/doxygen.sh $SRC
+</div>
+
 <?php include "footer.inc" ?>
[prev in list] [next in list] [prev in thread] [next in thread]