git://wamblee.org / utils / commitdiff
? search:
summary | shortlog | log | commit | commitdiff | tree
raw | patch | inline | side by side (parent: 39fcb56)
some improvements in the docs.
authorerik <erik@77661180-640e-0410-b3a8-9f9b13e6d0e0>
Sun, 20 Jun 2010 20:26:36 +0000 (20:26 +0000)
committererik <erik@77661180-640e-0410-b3a8-9f9b13e6d0e0>
Sun, 20 Jun 2010 20:26:36 +0000 (20:26 +0000)
support/general/src/site/xdoc/index.xml patch | blob | history
support/general/src/site/xdoc/userguide.xml patch | blob | history

diff --git a/support/general/src/site/xdoc/index.xml b/support/general/src/site/xdoc/index.xml
index ff5261e1566268c660e852107276d0df6181217f..3406913ebd24eee94045136aa80d6ceca2e31f10 100644 (file)
--- a/support/general/src/site/xdoc/index.xml
+++ b/support/general/src/site/xdoc/index.xml
@@ -10,7 +10,17 @@
   <body>
     <section name="Introduction">
       <p>The general support library contains various smaller utilities that
-         can be useful for any java project. </p>
+         can be useful for any java project. 
+      </p>
+      <p>
+        The purpose of this documentation is threefold: 
+      </p>
+      <ul>
+        <li>To allow others and myself to use this library.</li>
+        <li>To document the current state of development (some parts may be deprecated because of
+          other evolutions in technology).</li>
+        <li>To allow extension of the library.</li>
+      </ul>
     </section>
   </body>
 </document>
diff --git a/support/general/src/site/xdoc/userguide.xml b/support/general/src/site/xdoc/userguide.xml
index 4bd2d55e4a4bde8820d09b295d125e0783596891..713422137ac02beafeedc99aa7c0a139ec92d119 100644 (file)
--- a/support/general/src/site/xdoc/userguide.xml
+++ b/support/general/src/site/xdoc/userguide.xml
@@ -11,16 +11,16 @@
     <section name="Overview">
       <p>Utilities are available in the following areas:</p>
       <ul>
-        <li>Caching</li>
-        <li>Conditions</li>
-        <li>Collections</li>
-        <li>Concurrency</li>
+        <li><a href="apidocs/org/wamblee/cache/package-summary.html">Caching</a></li>
+        <li><a href="apidocs/org/wamblee/conditions/package-summary.html">Conditions</a></li>
+        <li><a href="apidocs/org/wamblee/collections/package-summary.html">Collections</a></li>
+        <li><a href="apidocs/org/wamblee/concurrency/package-summary.html">Concurrency</a></li>
         <li>General: TODO Rename to IOC</li>
-        <li>io</li>
-        <li>observer</li>
-        <li>persistence</li>
-        <li>reflection</li>
-        <li>xml</li>
+        <li><a href="apidocs/org/wamblee/io/package-summary.html">io</a></li>
+        <li><a href="apidocs/org/wamblee/observer/package-summary.html">observer</a></li>
+        <li><a href="apidocs/org/wamblee/persistence/package-summary.html">persistence</a></li>
+        <li><a href="apidocs/org/wamblee/reflection/package-summary.html">reflection</a></li>
+        <li><a href="apidocs/org/wamblee/xml/package-summary.html">xml</a></li>
       </ul>
     </section>
 
http://utils.wamblee.org