commonsrdf-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From st...@apache.org
Subject [1/2] incubator-commonsrdf git commit: Basic package-info for javadocs
Date Tue, 21 Apr 2015 10:37:17 GMT
Repository: incubator-commonsrdf
Updated Branches:
  refs/heads/master 1066057b1 -> 76a4df3b4


Basic package-info for javadocs


Project: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/commit/4fd9cf9a
Tree: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/tree/4fd9cf9a
Diff: http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/diff/4fd9cf9a

Branch: refs/heads/master
Commit: 4fd9cf9ae6160ab4ac25d3e2f75dc2994d344ca7
Parents: 1066057
Author: Stian Soiland-Reyes <stain@apache.org>
Authored: Tue Apr 21 11:23:02 2015 +0100
Committer: Stian Soiland-Reyes <stain@apache.org>
Committed: Tue Apr 21 11:36:40 2015 +0100

----------------------------------------------------------------------
 .../apache/commons/rdf/api/package-info.java    | 54 ++++++++++++++++++++
 .../apache/commons/rdf/simple/package-info.java | 27 ++++++----
 2 files changed, 71 insertions(+), 10 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4fd9cf9a/api/src/main/java/org/apache/commons/rdf/api/package-info.java
----------------------------------------------------------------------
diff --git a/api/src/main/java/org/apache/commons/rdf/api/package-info.java b/api/src/main/java/org/apache/commons/rdf/api/package-info.java
new file mode 100644
index 0000000..04f65a8
--- /dev/null
+++ b/api/src/main/java/org/apache/commons/rdf/api/package-info.java
@@ -0,0 +1,54 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License.  You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+/**
+ * Commons RDF, a common library of RDF 1.1 concepts.
+ * <p>
+ * The core <a href="http://www.w3.org/TR/rdf11-concepts/">RDF 1.1 concepts</a>
+ * are represented by corresponding interfaces:
+ * <p>
+ * A {@link org.apache.commons.rdf.api.Graph} is a collection of
+ * {@link org.apache.commons.rdf.api.Triple}s,
+ * which have a <em>subject</em>, <em>predicate</em> and <em>object</em>
of
+ * {@link org.apache.commons.rdf.api.RDFTerm}s.
+ * The three types of RDF terms are {@link org.apache.commons.rdf.api.IRI},
+ * {@link org.apache.commons.rdf.api.Literal} and
+ * {@link org.apache.commons.rdf.api.BlankNode}.
+ * <p>
+ * Implementations of this API should provide an
+ * {@link org.apache.commons.rdf.api.RDFTermFactory} to facilitate
+ * creation of these objects.
+ * <p>
+ * All the {@link org.apache.commons.rdf.api.RDFTerm} objects are immutable,
+ * while a {@link org.apache.commons.rdf.api.Graph}
+ * MAY be mutable (e.g. support methods like
+ * {@link org.apache.commons.rdf.api.Graph#add(Triple)}).
+ * <p>
+ * The {@link org.apache.commons.rdf.simple}
+ * implementation
+ * is provided as part of Commons RDF, this is a naive,
+ * minimal implementation of these interfaces,
+ * primarily to facilitate testing and prototyping.
+ * <p>
+ * For further documentation and contact details, see the
+ * <a href="http://commonsrdf.incubator.apache.org/">Commons RDF</a>
+ * web site.
+ *
+ */
+package org.apache.commons.rdf.api;
+
+

http://git-wip-us.apache.org/repos/asf/incubator-commonsrdf/blob/4fd9cf9a/simple/src/main/java/org/apache/commons/rdf/simple/package-info.java
----------------------------------------------------------------------
diff --git a/simple/src/main/java/org/apache/commons/rdf/simple/package-info.java b/simple/src/main/java/org/apache/commons/rdf/simple/package-info.java
index 66f6c83..626154f 100644
--- a/simple/src/main/java/org/apache/commons/rdf/simple/package-info.java
+++ b/simple/src/main/java/org/apache/commons/rdf/simple/package-info.java
@@ -1,4 +1,4 @@
-/**
+/*
  * Licensed to the Apache Software Foundation (ASF) under one
  * or more contributor license agreements. See the NOTICE file
  * distributed with this work for additional information
@@ -15,21 +15,28 @@
  * See the License for the specific language governing permissions and
  * limitations under the License.
  */
-package org.apache.commons.rdf.simple;
-
 /**
  * A simple in-memory implementation of the Commons RDF API.
  * <p>
- * This package contains a simple (if not naive) implementation of the Commons RDF API 
+ * This package contains a simple (if not naive) implementation of
+ * {@link org.apache.commons.rdf.api}
  * using in-memory POJO objects.
  * <p>
  * Note that although this module fully implements the commons-rdf API,
- * it should *not*  be considered a reference implementation. 
- * It is not thread-safe nor scalable, but may be useful for testing
- * and simple usage (e.g. output from an independent RDF parser).
+ * it should <strong>not</strong>  be considered a reference implementation.
+ * It is <strong>not thread-safe</strong> nor scalable, but may be useful for
+ * testing and simple usage (e.g. prototyping).
+ * <p>
+ * To use this implementation, create an instance of
+ * {@link org.apache.commons.rdf.simple.SimpleRDFTermFactory}
+ * and use methods like
+ * {@link org.apache.commons.rdf.simple.SimpleRDFTermFactory#createGraph} and
+ * {@link org.apache.commons.rdf.simple.SimpleRDFTermFactory#createIRI(String)}.
  * <p>
- * To use this implementation, create an instance of {@link SimpleRDFTermFactory}
- * and use methods like {@link SimpleRDFTermFactory#createGraph} and 
- * {@link SimpleRDFTermFactory#createIRI(String)}.
+ * The {@link org.apache.commons.rdf.simple.Types} class provide constant
+ * {@link org.apache.commons.rdf.api.IRI}s of the common RDF XML datatypes.
  *
  */
+package org.apache.commons.rdf.simple;
+
+


Mime
View raw message