javadoc cleanup

eclipse-rdf4j · Aug 1, 2019 · dcf9685 · dcf9685
1 parent b2f894b
commit dcf9685
Show file tree

Hide file tree

Showing 19 changed files with 53 additions and 49 deletions.
diff --git a/elasticsearch/src/main/java/org/eclipse/rdf4j/sail/elasticsearch/package-info.java b/elasticsearch/src/main/java/org/eclipse/rdf4j/sail/elasticsearch/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * ElasticSearch index for the {@link LuceneSail}.
+ */
+package org.eclipse.rdf4j.sail.elasticsearch;
diff --git a/federation/src/main/java/org/eclipse/rdf4j/sail/federation/package-info.java b/federation/src/main/java/org/eclipse/rdf4j/sail/federation/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * A Sail implementation for federated access to multiple databases.
+ */
+package org.eclipse.rdf4j.sail.federation;
diff --git a/inferencer/src/main/java/org/eclipse/rdf4j/sail/inferencer/fc/package-info.java b/inferencer/src/main/java/org/eclipse/rdf4j/sail/inferencer/fc/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Forward-chaining inferencers, implemented as {@link StackableSail}s.
+ */
+package org.eclipse.rdf4j.sail.inferencer.fc;
diff --git a/inferencer/src/main/java/org/eclipse/rdf4j/sail/inferencer/fc/package.html b/inferencer/src/main/java/org/eclipse/rdf4j/sail/inferencer/fc/package.html
diff --git a/lucene-api/src/main/java/org/eclipse/rdf4j/sail/lucene/package-info.java b/lucene-api/src/main/java/org/eclipse/rdf4j/sail/lucene/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * A Sail implementation that supports full-text indexing via the Lucene API.
+ */
+package org.eclipse.rdf4j.sail.lucene;
diff --git a/memory/src/main/java/org/eclipse/rdf4j/sail/memory/design.txt b/memory/src/main/java/org/eclipse/rdf4j/sail/memory/design.txt
diff --git a/memory/src/main/java/org/eclipse/rdf4j/sail/memory/package-info.java b/memory/src/main/java/org/eclipse/rdf4j/sail/memory/package-info.java
@@ -0,0 +1,6 @@
+/**
+ * An implementation of the RDF SAIL API that uses main memory for storage.
+ * 
+ * This implementation uses a bipartite graph as data structure.
+ */
+package org.eclipse.rdf4j.sail.memory;
diff --git a/memory/src/main/java/org/eclipse/rdf4j/sail/memory/package.html b/memory/src/main/java/org/eclipse/rdf4j/sail/memory/package.html
diff --git a/nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/package-info.java b/nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * The Native Store.
+ */
+package org.eclipse.rdf4j.sail.nativerdf;
diff --git a/nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/package.html b/nativerdf/src/main/java/org/eclipse/rdf4j/sail/nativerdf/package.html
diff --git a/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/helpers/package-info.java b/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/helpers/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Helper and utility classes for the {@link SailRepository}
+ */
+package org.eclipse.rdf4j.repository.sail.helpers;
diff --git a/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/package-info.java b/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Repository implementation for local RDF databases that implement the SAIL SPI.
+ */
+package org.eclipse.rdf4j.repository.sail;
diff --git a/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/package.html b/repository-sail/src/main/java/org/eclipse/rdf4j/repository/sail/package.html
diff --git a/sail-api/src/main/java/org/eclipse/rdf4j/sail/helpers/package-info.java b/sail-api/src/main/java/org/eclipse/rdf4j/sail/helpers/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Abstract base implementation and internal helper classes for Sail implementations.
+ */
+package org.eclipse.rdf4j.sail.helpers;
diff --git a/sail-api/src/main/java/org/eclipse/rdf4j/sail/helpers/package.html b/sail-api/src/main/java/org/eclipse/rdf4j/sail/helpers/package.html
diff --git a/sail-api/src/main/java/org/eclipse/rdf4j/sail/package-info.java b/sail-api/src/main/java/org/eclipse/rdf4j/sail/package-info.java
@@ -0,0 +1,7 @@
+/**
+ * RDF Storage And Inference Layer (RDF Sail): a set of interfaces defining an SPI for RDF databases.
+ * 
+ * The main interface is {@link org.eclipse.rdf4j.sail.Sail}, which defines methods for initialization, querying and
+ * starting transactions.
+ */
+package org.eclipse.rdf4j.sail;
diff --git a/sail-api/src/main/java/org/eclipse/rdf4j/sail/package.html b/sail-api/src/main/java/org/eclipse/rdf4j/sail/package.html
diff --git a/sail-base/src/main/java/org/eclipse/rdf4j/sail/base/package-info.java b/sail-base/src/main/java/org/eclipse/rdf4j/sail/base/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Base functionality for Sail implementations that require multi-versioned concurrency control (MVCC).
+ */
+package org.eclipse.rdf4j.sail.base;
diff --git a/shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/package-info.java b/shacl/src/main/java/org/eclipse/rdf4j/sail/shacl/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * A Sail implementation for <a href="https://www.w3.org/TR/shacl/">SHACL</a> constraint checking.
+ */
+package org.eclipse.rdf4j.sail.shacl;