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

List:       kde-commits
Subject:    developer.kde.org
From:       Adriaan de Groot <groot () kde ! org>
Date:       2005-09-01 13:56:23
Message-ID: 1125582983.811652.11995.nullmailer () svn ! kde ! org
[Download RAW message or body]

SVN commit 455828 by adridg:

Link in apidox howto again, fix broken links

 M  +0 -4      documentation/library/general/index.html  
 M  +1 -1      documentation/library/howto.php  
 M  +5 -0      documentation/library/libraryref.php  
 M  +8 -0      documentation/other/index.html  
 M  +1 -1      policies/menu.inc  


--- trunk/developer.kde.org/documentation/library/general/index.html #455827:455828
@@ -6,10 +6,6 @@
 
 <ul class="linklist">
 
-<li>    <a href="http://www.doxygen.org">Doxygen</a> (including manual)
-        <p>Doxygen is the tool with which KDE's API documentation is made</p>
-</li>
-
 <li>	<a href="/documentation/other/binarycompatibility.html">Binary Compatibility \
Issues With C++</a>  <p>		How to maintain binary compatibility between different \
versions of C++ libraries.	</p>  </li>
--- trunk/developer.kde.org/documentation/library/howto.php #455827:455828
@@ -88,7 +88,7 @@
 <p>This document is going to try to prevent the apidox
 process from becoming exhausting, by giving straightforward
 tips about how to go about writing apidox.
-There are also the <a href="policy.php">apidox policies</a>,
+There are also the <a href="policies/documentationpolicy.php">apidox policies</a>,
 which are much <em>much</em> stricter, which
 provide measurable properties that apidox
 must adhere to.
--- trunk/developer.kde.org/documentation/library/libraryref.php #455827:455828
@@ -15,6 +15,11 @@
 by processing the source code itself, and
 thus can vary considerably per release.
 In particular, coverage of later releases is much better.
+For creating API reference manuals,
+you might want to consult the 
+<a href="http://www.stack.nl/~dimitri/doxygen/manual.html">Doxygen manual</a>
+or the
+<a href="howto.php">KDE API Reference HOWTO</a>.
 </p>
 
 
--- trunk/developer.kde.org/documentation/other/index.html #455827:455828
@@ -77,6 +77,14 @@
   <p>Describes the changes you have to apply to programs written for KDE2.x when you \
want to port them to KDE3.0.	</p>  </li>
 
+<li>
+  <a href="/documentation/library/howto.php">KDE API Reference Documentation \
HOWTO</a> +  <p>This HOWTO describes the process of writing API Reference \
Documentation +  (apidox) for KDE libraries and applications.
+  It deals with some basic Doxygen techniques, a KDE styleguide
+  for apidox, and covers the
+  integration of apidox into the KDE build system.
+  </p>
 </ul>
 
 <h1>FAQ Collections</h1>
--- trunk/developer.kde.org/policies/menu.inc #455827:455828
@@ -9,7 +9,7 @@
 $this->appendLink ("Security Policy", "securitypolicy.html",
                    "How security problems reported to security@kde.org are \
handled.");  
-$this->appendLink ("Library Documentation Policy", "documentationpolicy.html",
+$this->appendLink ("Library Documentation Policy", "documentationpolicy.php",
                    "Documentation policy for files in kdelibs.");
 
 $this->appendLink ("KDE Package Policy", \
"http://www.kde.org/download/packagepolicy.php",


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