fixed some doc strings. added sample makefile

git-svn-id: svn://svn.open-ils.org/OpenSRF/trunk@886 9efc2488-bf62-4759-914b-345cdb29e865

diff --git a/src/java/Makefile b/src/java/Makefile
new file mode 100644 (file)
index 0000000..67891e7
--- /dev/null
+++ b/src/java/Makefile
@@ -0,0 +1,39 @@
+#JAVA_LIBS = .:lib:ext/json-jdk1.5-2007-05-01.jar:ext/wstx-asl-3.2.1.jar:ext/stax-api-1.0.1.jar:ext/xercesImpl-1.4.4-2.jar
+JAVA_LIBDIR = .lib
+JAVAC=javac -J-Xmx256m
+JAVA=java -Xmx256m 
+JAVA_LIBS = .:$(JAVA_LIBDIR):ext/json-jdk1.5-2007-05-01.jar:ext/wstx-asl-3.2.1.jar:ext/stax-api-1.0.1.jar
+JAVA_SRC = \
+       org/opensrf/net/xmpp/*.java \
+       org/opensrf/util/*.java \
+       org/opensrf/*.java \
+       org/opensrf/test/*.java 
+
+all:
+       mkdir -p $(JAVA_LIBDIR)
+       $(JAVAC) -d $(JAVA_LIBDIR) -cp $(JAVA_LIBS) $(JAVA_SRC) 2>&1 
+
+# only prints the first 30 lines of errors
+slim:
+       mkdir -p $(JAVA_LIBDIR)
+       $(JAVAC) -d $(JAVA_LIBDIR) -cp $(JAVA_LIBS) $(JAVA_SRC) 2>&1 | head -n 30
+       @echo -e "\nTruncating at 30 lines"
+
+check:
+       mkdir -p $(JAVA_LIBDIR)
+       $(JAVAC) -Xlint:unchecked -d $(JAVA_LIBDIR) -cp $(JAVA_LIBS) $(JAVA_SRC) 2>&1 | head -n 30
+       @echo -e "\nTruncating at 30 lines"
+
+run:
+       $(JAVA) -cp $(JAVA_LIBS) $(JAVA_EXE) $(JAVA_ARGS)
+
+docs:
+       find . -name *.java > files;
+       javadoc -classpath $(JAVA_LIBS) -d doc @files;
+       rm files;
+
+clean:
+       rm -r $(JAVA_LIBDIR)
+       
+
+

diff --git a/src/java/org/opensrf/net/xmpp/XMPPReader.java b/src/java/org/opensrf/net/xmpp/XMPPReader.java
index 3c06b11..01a4f91 100644 (file)
--- a/src/java/org/opensrf/net/xmpp/XMPPReader.java
+++ b/src/java/org/opensrf/net/xmpp/XMPPReader.java
@@ -153,7 +153,6 @@ public class XMPPReader implements Runnable {
 
     /**
      * Parses XML data from the provided XMPP stream.
-     * @param inStream The stream to parse.
      */
     public void read() {
 

diff --git a/src/java/org/opensrf/util/Config.java b/src/java/org/opensrf/util/Config.java
index 03de8ac..7b3a0bf 100644 (file)
--- a/src/java/org/opensrf/util/Config.java
+++ b/src/java/org/opensrf/util/Config.java
@@ -50,7 +50,6 @@ public class Config {
 
     /**
      * Returns the configuration value found at the requested path.
-     * @see org.opensrf.util.Utils.findPath for path description.
      * @param path The search path
      * @return The config value, or null if no value exists at the given path.  
      * @throws ConfigException thrown if nothing is found at the path
@@ -79,7 +78,6 @@ public class Config {
 
     /**
      * Returns the configuration object found at the requested path.
-     * @see org.opensrf.util.Utils.findPath for path description.
      * @param path The search path
      * @return The config value
      * @throws ConfigException thrown if nothing is found at the path

diff --git a/src/java/org/opensrf/util/JSONReader.java b/src/java/org/opensrf/util/JSONReader.java
index 634c249..b115140 100644 (file)
--- a/src/java/org/opensrf/util/JSONReader.java
+++ b/src/java/org/opensrf/util/JSONReader.java
@@ -23,7 +23,7 @@ public class JSONReader {
     private String json;
 
     /**
-     * @param The JSON to parse
+     * @param json The JSON to parse
      */
     public JSONReader(String json) {
         this.json = json;
@@ -31,7 +31,6 @@ public class JSONReader {
 
     /**
      * Parses JSON and creates an object.
-     * @param json The JSON string to parse
      * @return The resulting object which may be a List, 
      * Map, Number, String, Boolean, or null
      */

diff --git a/src/java/org/opensrf/util/JSONWriter.java b/src/java/org/opensrf/util/JSONWriter.java
index 6af7e3e..7cb2cca 100644 (file)
--- a/src/java/org/opensrf/util/JSONWriter.java
+++ b/src/java/org/opensrf/util/JSONWriter.java
@@ -21,7 +21,7 @@ public class JSONWriter {
 
 
     /**
-     * @see write(Object, StringBuffer)
+     * Encodes a java object to JSON.
      */
     public String write() {
         StringBuffer sb = new StringBuffer();

diff --git a/src/java/org/opensrf/util/Utils.java b/src/java/org/opensrf/util/Utils.java
index 9bf819f..159d254 100644 (file)
--- a/src/java/org/opensrf/util/Utils.java
+++ b/src/java/org/opensrf/util/Utils.java
@@ -26,7 +26,7 @@ public class Utils {
 
 
     /**
-     * @see escape(String, StringBuffer)
+     * Escapes a string.
      */
     public static String escape(String string) {
         StringBuffer sb = new StringBuffer();