Added an build-target to the ant-configuration to create the

yacy-javadoc-documentation in doc/api. Just do ant create-doc and point your
favourite browser to doc/api/index.html. As most of the classes are not
documented right now this just gives a great overview of all classes.
Hopefully this helps stimulating the creation of
javadoc-insource-documentation.


git-svn-id: https://svn.berlios.de/svnroot/repos/yacy/trunk@502 6c8d7289-2bf4-0310-a012-ef5d649a1542

build.xml

@@ -468,4 +468,13 @@
   </java>
 </target>
 
+<!-- create the html-documentation from javadoc  -->
+<target name="create-doc" description="Create the javadoc-HTML-Pages">
+  <javadoc destdir="doc/api" version="no" use="yes" encoding="iso-8859-1" windowtitle="YaCy API Documentation">
+    <fileset dir="source" defaultexcludes="yes">
+      <include name="**/*.java" />
+    </fileset>
+  </javadoc>
+</target>
+
 </project>

source/de/anomic/http/httpc.java

@@ -38,15 +38,6 @@
 // the intact and unchanged copyright notice.
 // Contributions and changes to the program code must be marked as such.
 
-/*
-   Class documentation:
-   this class forms an http client
-   while http access is built-in in java libraries, it is still
-   necessary to implement the network interface since otherwise
-   there is no access to the HTTP/1.0 / HTTP/1.1 header information
-   that comes along each connection.
- */
-
 package de.anomic.http;
 
 import java.io.ByteArrayOutputStream;
@@ -86,6 +77,12 @@ import de.anomic.server.serverCore.Session;
 
 import org.apache.commons.pool.impl.GenericObjectPool;
 
+/**
+*  This class implements an http client. While http access is built-in in java
+*  libraries, it is still necessary to implement the network interface since
+*  otherwise there is no access to the HTTP/1.0 / HTTP/1.1 header information
+*  that comes along each connection.
+*/
 public final class httpc {
 
     // statics