[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:13:26
Message-ID: 1143983606.892042.3241.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 525562 by adridg:

It helps to write the CSS properly; start documenting how to test apidox locally.

 M  +1 -1      howto.css  
 M  +84 -2     howto.php  


--- trunk/www/sites/developer/documentation/library/howto.css #525561:525562
@@ -47,7 +47,7 @@
 div.warn { background-image: url(img/warning.png); }
 div.build { background-image: url(img/build.png); margin-top: 2ex; white-space : \
pre; }  div.broken { background-image: url(img/broken.png); }
-div.broken { background-image: url(img/shellscript.png); }
+div.shell { background-image: url(img/shellscript.png); white-space: pre; }
 
 li div.figure, li div.note, li div.dox ,li  div.warn, li div.build {
 margin-left: 0px;
--- trunk/www/sites/developer/documentation/library/howto.php #525561:525562
@@ -126,13 +126,30 @@
 of what examples can look like.
 </div>
 
-<div class="build" style="white-space: normal;">Finally,
-comments relating to other files
+<div class="build" style="white-space: normal;">
+Comments relating to other files
 on your system (configuration,
 source, Makefiles, whatever)
 look like this.
 </div>
 
+<div class="shell" style="white-space: normal;">
+Things to type into a shell
+prompt (a Bourne shell, so no csh)
+are written in this kind of boxes.
+Comments are indicated with a #,
+which commands you type are indicated with a
+$ (do not type the $).
+</div>
+
+<div class="broken">
+Finally, some parts of this HOWTO may be
+broken, incomplete, or erroneous.
+These may be marked with comments
+that look like this to indicate that
+the document isn't finished yet.
+</div>
+
 <h2><a name="basics"></a>APIDOX Basics</h2>
 
 <p>APIDOX are processed by the
@@ -1229,4 +1246,69 @@
 
 <h2><a name="check"></a>Checking APIDOX</h2>
 
+<p>
+The APIDOX for KDE 3.5 (current release) and KDE trunk/ 
+(development version) are re-built every 12 hours on
+the <a href="http://www.englishbreakfastnetwork.org/apidocs/">English
+Breakfast Network</a>, an otherwise unaffiliated server.
+Log files are produced where you can check if your APIDOX
+are syntactically correct and document everything that is needed.
+In addition, you can see the output of your new APIDOX
+in the generated HTML output.
+The <a href="http://developer.kde.org/documentation/library/libraryref.php">official \
KDE APIDOX</a> +updates once a week.
+</p>
+
+<p>You may also want to build APIDOX yourself, so you do
+not have to go through the commit-wait-check cycle but
+can immediately see the results of your APIDOX corrections.
+To do so you will need to build APIDOX by hand. This
+requires at <em>least</em> <a \
href="http://www.doxygen.org/download.html#latestsrc">Doxygen 1.4</a> (1.4.6, the \
+lastest version as of this writing, is recommended). +Some features of the APIDOX \
may only be available if +you have additional tools installed, like graphviz.
+</p>
+
+<ol>
+<li>
+You must have either kdelibs installed -- for the version of
+KDE you are writing APIDOX for -- or a SVN checkout of kdelibs.
+You will need files from one or the other source.
+If you have KDE installed, you need files from
+<span class="file">share/doc/HTML/en/common/</span>
+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:
+
+
+<div class="shell">
+  # For installed KDE
+$ DOXDATADIR=<i>/path/to/kde/</i>share/doc/HTML/en/common/
+  # For SVN checkout
+$ DOXDATADIR=<i>/path/to/checkout/kdelibs/</i>doc/common/
+</div>
+</li>
+
+<li>
+You need an appropriate Qt Doxygen tag file.
+You can get
+<a href="http://www.englishbreakfastnetwork.org/apidocs/apidox-3.5/qt.tag">a Qt 3.5 \
tag file</a> +from the EBN; this is somewhat usable for KDE trunk/ as well, but not
+ideal.
+You may also generate a Qt tag file yourself if you have
+the Qt headers installed. Change directory to the include directory 
+of Qt and run doxytag as follows:
+<div class="shell">
+$ cd <i>/path/to/qt/include</i>
+$ doxytag -t /tmp/qt.tag
+</div>
+Put the <span class="file">qt.tag</span> file somewhere
+you can find it, and set the shell variable QTDOCTAG appropriately:
+<div class="shell">
+$ QTDOCTAG=<i>/path/to/qt.tag</i>
+</div>
+</li>
+</ol>
+
 <?php include "footer.inc" ?>


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