Permalink
Browse files

rfe9883: javadoc included in the distribution

moved javadoc.xml into build.xml and cleaned up the code, added
copyright, links to java, jena, and sesame javadocs

<release-note>
rfe9883: javadoc included in the distribution

Javadocs for com.franz.agraph are in the javadoc folder in
the distribution file, and they link to external javadocs
for java, jena, and sesame.
</release-note>

Change-Id: Iccadc0a811fb133dae859a021cdb42505d8bc291
Reviewed-on: https://gerrit.franz.com:9080/519
Reviewed-by: John O'Rourke <john.orourke@franz.com>
Reviewed-by: Kevin Layer <layer@franz.com>
Tested-by: Kevin Layer <layer@franz.com>
  • Loading branch information...
1 parent 792fc3c commit 648982b2fe977a5b14e7df397fb7db545e513a55 Mike Hinchey committed with dklayer Oct 6, 2010
View
63 build.xml
@@ -1,4 +1,4 @@
-<project name="agraph-java-client" default="clean-build"
+<project name="agraph-java-client" default="build"
xmlns:artifact="antlib:org.apache.maven.artifact.ant">
<property environment="env"/>
@@ -59,6 +59,7 @@
description="Remove generated files and directories.">
<delete dir="${build}"/>
<delete file="${jarfile}"/>
+ <delete dir="doc"/>
<delete file="agraph-java-client-test.jar"/>
<ant dir="clojure" target="clean" inheritall="false"/>
</target>
@@ -71,16 +72,15 @@
classpathref="classpath"/>
</target>
- <manifestclasspath property="mf.path" jarfile="${jarfile}">
- <classpath refid="classpath"/>
- </manifestclasspath>
-
- <target name="build"
- description="Create jar file."
- depends="clean, compile">
- <tstamp prefix="jar">
- <format property="datestamp" pattern="yyyy-MM-dd H:mm"/>
- </tstamp>
+ <target name="jar"
+ description="Build agraph.jar file."
+ depends="compile">
+ <manifestclasspath property="mf.path" jarfile="${jarfile}">
+ <classpath refid="classpath"/>
+ </manifestclasspath>
+ <tstamp prefix="jar">
+ <format property="datestamp" pattern="yyyy-MM-dd H:mm"/>
+ </tstamp>
<jar jarfile="${jarfile}">
<fileset dir="${build}" includes="**/*.class">
<exclude name="tutorial/**"/>
@@ -98,12 +98,16 @@
</jar>
</target>
+ <target name="build" depends="clean, jar"
+ description="clean, and build jar">
+ </target>
+
<target name="test-jar"
description="Create jar file of test classes."
depends="compile">
- <tstamp prefix="jar">
- <format property="datestamp" pattern="yyyy-MM-dd H:mm"/>
- </tstamp>
+ <tstamp prefix="jar">
+ <format property="datestamp" pattern="yyyy-MM-dd H:mm"/>
+ </tstamp>
<jar jarfile="agraph-java-client-test.jar">
<fileset dir="${build}">
<include name="tutorial/**"/>
@@ -119,14 +123,37 @@
</manifest>
</jar>
</target>
-
- <target name="clean-build" depends="clean, build"
- description="clean, and build jar">
+
+ <target name="javadoc"
+ description="Generate javadocs to the doc directory">
+ <delete dir="doc"/>
+ <javadoc destdir="doc"
+ access="public"
+ author="true"
+ doctitle="Franz, Inc. AllegroGraph ${env.version} Javadoc"
+ header="Franz Inc, AllegroGraph"
+ footer="Copyright &amp;copy; 2008-2010 Franz Inc."
+ nodeprecated="false"
+ nodeprecatedlist="false"
+ noindex="false"
+ nonavbar="false"
+ notree="false"
+ packagenames="com.franz.agraph.jena,com.franz.util,com.franz.agraph.repository"
+ source="1.6"
+ sourcepath="src"
+ splitindex="true"
+ use="true"
+ version="true"
+ classpathref="classpath">
+ <link href="http://download.oracle.com/javase/6/docs/api/" offline="true" packagelistLoc="lib/java"/>
+ <link href="http://openjena.org/javadoc/" offline="true" packagelistloc="lib/jena-2.6.2"/>
+ <link href="http://www.openrdf.org/doc/sesame2/2.3.1/apidocs/" offline="true" packagelistloc="lib/sesame-2.3.1"/>
+ </javadoc>
</target>
<target name="prepush"
description="Tests required before git push: clean, build, and run Java and Clojure client tests"
- depends="clean-build, test-prepush">
+ depends="build, test-prepush">
<ant dir="clojure" target="prepush" inheritall="false"/>
</target>
View
6 javadoc.xml
@@ -1,6 +0,0 @@
-<?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<project default="javadoc">
- <target name="javadoc">
- <javadoc access="public" author="true" classpath="lib/jena-2.6.2/stax-api-1.0.1.jar;lib/json.jar;lib/jena-2.6.2/jena-2.6.2.jar;lib/sesame-2.3.1/commons-logging-1.1.1.jar;lib/jena-2.6.2/arq-2.8.1.jar;lib/jena-2.6.2/jena-2.6.2-tests.jar;lib/sesame-2.3.1/slf4j-nop-1.5.8.jar;lib/jena-2.6.2/wstx-asl-3.2.9.jar;lib/jena-2.6.2/xercesImpl-2.7.1.jar;lib/sesame-2.3.1/openrdf-sesame-2.3.1-onejar.jar;lib/jena-2.6.2/icu4j-3.4.4.jar;lib/sesame-2.3.1/slf4j-api-1.5.8.jar;lib/junit-4.8.1.jar;lib/jena-2.6.2/lucene-core-2.3.1.jar;lib/sesame-2.3.1/commons-httpclient-3.1.jar;lib/jena-2.6.2/iri-0.7.jar;lib/sesame-2.3.1/commons-codec-1.3.jar" destdir="doc" doctitle="AllegroGraph 4.0 Javadoc" nodeprecated="false" nodeprecatedlist="false" noindex="false" nonavbar="false" notree="false" packagenames="com.franz.agraph.jena,com.franz.util,com.franz.agraph.repository" source="1.6" sourcepath="src" splitindex="true" use="true" version="true"/>
- </target>
-</project>
View
203 lib/java/package-list
@@ -0,0 +1,203 @@
+java.applet
+java.awt
+java.awt.color
+java.awt.datatransfer
+java.awt.dnd
+java.awt.event
+java.awt.font
+java.awt.geom
+java.awt.im
+java.awt.im.spi
+java.awt.image
+java.awt.image.renderable
+java.awt.print
+java.beans
+java.beans.beancontext
+java.io
+java.lang
+java.lang.annotation
+java.lang.instrument
+java.lang.management
+java.lang.ref
+java.lang.reflect
+java.math
+java.net
+java.nio
+java.nio.channels
+java.nio.channels.spi
+java.nio.charset
+java.nio.charset.spi
+java.rmi
+java.rmi.activation
+java.rmi.dgc
+java.rmi.registry
+java.rmi.server
+java.security
+java.security.acl
+java.security.cert
+java.security.interfaces
+java.security.spec
+java.sql
+java.text
+java.text.spi
+java.util
+java.util.concurrent
+java.util.concurrent.atomic
+java.util.concurrent.locks
+java.util.jar
+java.util.logging
+java.util.prefs
+java.util.regex
+java.util.spi
+java.util.zip
+javax.accessibility
+javax.activation
+javax.activity
+javax.annotation
+javax.annotation.processing
+javax.crypto
+javax.crypto.interfaces
+javax.crypto.spec
+javax.imageio
+javax.imageio.event
+javax.imageio.metadata
+javax.imageio.plugins.bmp
+javax.imageio.plugins.jpeg
+javax.imageio.spi
+javax.imageio.stream
+javax.jws
+javax.jws.soap
+javax.lang.model
+javax.lang.model.element
+javax.lang.model.type
+javax.lang.model.util
+javax.management
+javax.management.loading
+javax.management.modelmbean
+javax.management.monitor
+javax.management.openmbean
+javax.management.relation
+javax.management.remote
+javax.management.remote.rmi
+javax.management.timer
+javax.naming
+javax.naming.directory
+javax.naming.event
+javax.naming.ldap
+javax.naming.spi
+javax.net
+javax.net.ssl
+javax.print
+javax.print.attribute
+javax.print.attribute.standard
+javax.print.event
+javax.rmi
+javax.rmi.CORBA
+javax.rmi.ssl
+javax.script
+javax.security.auth
+javax.security.auth.callback
+javax.security.auth.kerberos
+javax.security.auth.login
+javax.security.auth.spi
+javax.security.auth.x500
+javax.security.cert
+javax.security.sasl
+javax.sound.midi
+javax.sound.midi.spi
+javax.sound.sampled
+javax.sound.sampled.spi
+javax.sql
+javax.sql.rowset
+javax.sql.rowset.serial
+javax.sql.rowset.spi
+javax.swing
+javax.swing.border
+javax.swing.colorchooser
+javax.swing.event
+javax.swing.filechooser
+javax.swing.plaf
+javax.swing.plaf.basic
+javax.swing.plaf.metal
+javax.swing.plaf.multi
+javax.swing.plaf.synth
+javax.swing.table
+javax.swing.text
+javax.swing.text.html
+javax.swing.text.html.parser
+javax.swing.text.rtf
+javax.swing.tree
+javax.swing.undo
+javax.tools
+javax.transaction
+javax.transaction.xa
+javax.xml
+javax.xml.bind
+javax.xml.bind.annotation
+javax.xml.bind.annotation.adapters
+javax.xml.bind.attachment
+javax.xml.bind.helpers
+javax.xml.bind.util
+javax.xml.crypto
+javax.xml.crypto.dom
+javax.xml.crypto.dsig
+javax.xml.crypto.dsig.dom
+javax.xml.crypto.dsig.keyinfo
+javax.xml.crypto.dsig.spec
+javax.xml.datatype
+javax.xml.namespace
+javax.xml.parsers
+javax.xml.soap
+javax.xml.stream
+javax.xml.stream.events
+javax.xml.stream.util
+javax.xml.transform
+javax.xml.transform.dom
+javax.xml.transform.sax
+javax.xml.transform.stax
+javax.xml.transform.stream
+javax.xml.validation
+javax.xml.ws
+javax.xml.ws.handler
+javax.xml.ws.handler.soap
+javax.xml.ws.http
+javax.xml.ws.soap
+javax.xml.ws.spi
+javax.xml.ws.wsaddressing
+javax.xml.xpath
+org.ietf.jgss
+org.omg.CORBA
+org.omg.CORBA.DynAnyPackage
+org.omg.CORBA.ORBPackage
+org.omg.CORBA.TypeCodePackage
+org.omg.CORBA.portable
+org.omg.CORBA_2_3
+org.omg.CORBA_2_3.portable
+org.omg.CosNaming
+org.omg.CosNaming.NamingContextExtPackage
+org.omg.CosNaming.NamingContextPackage
+org.omg.Dynamic
+org.omg.DynamicAny
+org.omg.DynamicAny.DynAnyFactoryPackage
+org.omg.DynamicAny.DynAnyPackage
+org.omg.IOP
+org.omg.IOP.CodecFactoryPackage
+org.omg.IOP.CodecPackage
+org.omg.Messaging
+org.omg.PortableInterceptor
+org.omg.PortableInterceptor.ORBInitInfoPackage
+org.omg.PortableServer
+org.omg.PortableServer.CurrentPackage
+org.omg.PortableServer.POAManagerPackage
+org.omg.PortableServer.POAPackage
+org.omg.PortableServer.ServantLocatorPackage
+org.omg.PortableServer.portable
+org.omg.SendingContext
+org.omg.stub.java.rmi
+org.w3c.dom
+org.w3c.dom.bootstrap
+org.w3c.dom.events
+org.w3c.dom.ls
+org.xml.sax
+org.xml.sax.ext
+org.xml.sax.helpers
View
22 lib/jena-2.6.2/package-list
@@ -0,0 +1,22 @@
+com.hp.hpl.jena
+com.hp.hpl.jena.assembler
+com.hp.hpl.jena.datatypes
+com.hp.hpl.jena.datatypes.xsd
+com.hp.hpl.jena.db
+com.hp.hpl.jena.enhanced
+com.hp.hpl.jena.graph
+com.hp.hpl.jena.graph.compose
+com.hp.hpl.jena.graph.query
+com.hp.hpl.jena.ontology
+com.hp.hpl.jena.rdf.arp
+com.hp.hpl.jena.rdf.listeners
+com.hp.hpl.jena.rdf.model
+com.hp.hpl.jena.reasoner
+com.hp.hpl.jena.reasoner.rulesys
+com.hp.hpl.jena.reasoner.rulesys.builtins
+com.hp.hpl.jena.reasoner.transitiveReasoner
+com.hp.hpl.jena.shared
+com.hp.hpl.jena.util
+com.hp.hpl.jena.vocabulary
+com.hp.hpl.jena.xmloutput
+jena
View
103 lib/sesame-2.3.1/package-list
@@ -0,0 +1,103 @@
+org.openrdf
+org.openrdf.console
+org.openrdf.http.client
+org.openrdf.http.protocol
+org.openrdf.http.protocol.error
+org.openrdf.http.protocol.transaction
+org.openrdf.http.protocol.transaction.operations
+org.openrdf.http.server
+org.openrdf.http.server.protocol
+org.openrdf.http.server.repository
+org.openrdf.http.server.repository.contexts
+org.openrdf.http.server.repository.namespaces
+org.openrdf.http.server.repository.size
+org.openrdf.http.server.repository.statements
+org.openrdf.model
+org.openrdf.model.datatypes
+org.openrdf.model.impl
+org.openrdf.model.util
+org.openrdf.model.vocabulary
+org.openrdf.query
+org.openrdf.query.algebra
+org.openrdf.query.algebra.evaluation
+org.openrdf.query.algebra.evaluation.function
+org.openrdf.query.algebra.evaluation.impl
+org.openrdf.query.algebra.evaluation.iterator
+org.openrdf.query.algebra.evaluation.util
+org.openrdf.query.algebra.helpers
+org.openrdf.query.dawg
+org.openrdf.query.impl
+org.openrdf.query.parser
+org.openrdf.query.parser.serql
+org.openrdf.query.parser.serql.ast
+org.openrdf.query.parser.sparql
+org.openrdf.query.parser.sparql.ast
+org.openrdf.query.resultio
+org.openrdf.query.resultio.binary
+org.openrdf.query.resultio.sparqljson
+org.openrdf.query.resultio.sparqlxml
+org.openrdf.query.resultio.text
+org.openrdf.repository
+org.openrdf.repository.base
+org.openrdf.repository.config
+org.openrdf.repository.contextaware
+org.openrdf.repository.contextaware.config
+org.openrdf.repository.dataset
+org.openrdf.repository.dataset.config
+org.openrdf.repository.event
+org.openrdf.repository.event.base
+org.openrdf.repository.event.util
+org.openrdf.repository.http
+org.openrdf.repository.http.config
+org.openrdf.repository.manager
+org.openrdf.repository.manager.util
+org.openrdf.repository.sail
+org.openrdf.repository.sail.config
+org.openrdf.repository.util
+org.openrdf.rio
+org.openrdf.rio.helpers
+org.openrdf.rio.n3
+org.openrdf.rio.ntriples
+org.openrdf.rio.rdfxml
+org.openrdf.rio.rdfxml.util
+org.openrdf.rio.trig
+org.openrdf.rio.trix
+org.openrdf.rio.turtle
+org.openrdf.sail
+org.openrdf.sail.config
+org.openrdf.sail.helpers
+org.openrdf.sail.inferencer
+org.openrdf.sail.inferencer.fc
+org.openrdf.sail.inferencer.fc.config
+org.openrdf.sail.memory
+org.openrdf.sail.memory.config
+org.openrdf.sail.memory.model
+org.openrdf.sail.nativerdf
+org.openrdf.sail.nativerdf.btree
+org.openrdf.sail.nativerdf.config
+org.openrdf.sail.nativerdf.datastore
+org.openrdf.sail.nativerdf.model
+org.openrdf.sail.rdbms
+org.openrdf.sail.rdbms.algebra
+org.openrdf.sail.rdbms.algebra.base
+org.openrdf.sail.rdbms.algebra.factories
+org.openrdf.sail.rdbms.config
+org.openrdf.sail.rdbms.evaluation
+org.openrdf.sail.rdbms.exceptions
+org.openrdf.sail.rdbms.iteration
+org.openrdf.sail.rdbms.iteration.base
+org.openrdf.sail.rdbms.managers
+org.openrdf.sail.rdbms.managers.base
+org.openrdf.sail.rdbms.managers.helpers
+org.openrdf.sail.rdbms.model
+org.openrdf.sail.rdbms.mysql
+org.openrdf.sail.rdbms.optimizers
+org.openrdf.sail.rdbms.postgresql
+org.openrdf.sail.rdbms.schema
+org.openrdf.sail.rdbms.util
+org.openrdf.workbench
+org.openrdf.workbench.base
+org.openrdf.workbench.commands
+org.openrdf.workbench.exceptions
+org.openrdf.workbench.proxy
+org.openrdf.workbench.util
View
9 makefile
@@ -17,7 +17,11 @@ else
endif
javadoc: FORCE
- ant -f javadoc.xml
+ifndef VERSION
+ ant javadoc
+else
+ ant -Denv.version=$(VERSION) javadoc
+endif
tags: FORCE
rm -f TAGS
@@ -42,7 +46,7 @@ TARNAME = agraph-$(VERSION)-client-java.tar.gz
TAROPTS =
endif
-dist: clean build
+dist: clean build javadoc
ifndef VERSION
@echo VERSION is not defined.
@exit 1
@@ -68,6 +72,7 @@ endif
cp src/tutorial/java-tutorial-40.html $(DIST)/doc
cp src/tutorial/jena-tutorial-40.html $(DIST)/doc
cp src/tutorial/*.jpg $(DIST)/doc
+ cp -r doc $(DIST)/javadoc
tar -c -h -z $(TAROPTS) -f $(TARNAME) -C DIST $(DISTDIR)
ifdef DESTDIR
cp -p $(TARNAME) $(DESTDIR)
View
3 src/com/franz/agraph/repository/AGQuery.java
@@ -207,8 +207,7 @@ public void setPrepared(boolean prepared) {
}
@Override
- public String toString()
- {
+ public String toString() {
return queryString;
}
View
2 src/com/franz/agraph/repository/AGRepositoryConnection.java
@@ -784,7 +784,7 @@ public void registerSNANeighborMatrix(String matrix, String generator, List<URI>
/**
* Returns a list of all possible index types for this repository.
*
- * @return
+ * @return list of all possible index types for this repository.
* @throws OpenRDFException
*/
public List<String> listValidIndices() throws OpenRDFException {
View
4 src/com/franz/util/Closeable.java
@@ -9,10 +9,10 @@
package com.franz.util;
/**
- * Similar to java.io.Closeable, but close throws Exception so
+ * Similar to {@link java.io.Closeable}, but close throws Exception so
* it can be used with extentions of third-party classes
* (for example, Sesame and Jena) that define a close method
- * without implementing java.io.Closeable and with a different
+ * without implementing {@link java.io.Closeable} and with a different
* checked exception.
*/
public interface Closeable {

0 comments on commit 648982b

Please sign in to comment.