This is an automated email from the ASF dual-hosted git repository.
martin_s pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/archiva-components.git
The following commit(s) were added to refs/heads/master by this push:
new b6e0dc0 Updating documentation of components
b6e0dc0 is described below
commit b6e0dc021171b951a3bc9c91e9df5272e925d653
Author: Martin Stockhammer <[email protected]>
AuthorDate: Sat Nov 23 18:28:09 2019 +0100
Updating documentation of components
---
.gitignore | 2 +
README.adoc | 17 +++++---
expression-evaluator/.gitignore | 10 -----
expression-evaluator/pom.xml | 18 ++++++++
graph/pom.xml | 23 ++++++++--
.../apache/archiva/components/graph/api/Graph.java | 6 +--
.../archiva/components/graph/api/RelationType.java | 2 +-
.../components/graph/api/TraversalStatus.java | 2 +-
graph/src/site/asciidoc/index.adoc | 49 ++++++++++++++++++++++
graph/src/{main => }/site/site.xml | 0
pom.xml | 42 ++++++++++++++++++-
spring-apacheds/pom.xml | 19 +++++++++
spring-cache/pom.xml | 5 ++-
.../components/cache/builder/CacheBuilder.java | 4 +-
.../components/cache/factory/CacheCreator.java | 2 +-
.../components/cache/hashmap/HashMapCache.java | 2 +-
spring-registry/pom.xml | 32 +-------------
.../archiva/components/registry/Registry.java | 3 +-
spring-taskqueue/pom.xml | 18 ++++++++
.../src}/site/asciidoc/index.adoc | 10 +++--
src/site/asciidoc/index.adoc | 26 ++++++++++--
src/site/resources/css/site.css | 21 ++++++++++
src/site/site.xml | 2 +-
23 files changed, 246 insertions(+), 69 deletions(-)
diff --git a/.gitignore b/.gitignore
index d5addeb..e2d233b 100644
--- a/.gitignore
+++ b/.gitignore
@@ -23,3 +23,5 @@ out/
#netbeans file
nbactions.xml
nb-configuration.xml
+
+velocity.log
diff --git a/README.adoc b/README.adoc
index 7538349..49d95a4 100644
--- a/README.adoc
+++ b/README.adoc
@@ -1,16 +1,23 @@
-Archiva Documentation - Component Documentation
-
-=======================================================
+= Archiva Components
== Licensing information
Archiva Compontents is developed under the Apache License Version 2.0
-
:toc:
This is project contains multiple (mostly independent) modules used by
different projects related
-to Apache Archiva.
+to Apache Archiva.
+
+The components are:
+
+* expression-evaluator
+* graph
+* spring-apacheds
+* spring-cache
+* spring-registry
+* spring-taskqueue
+
== Development
diff --git a/expression-evaluator/.gitignore b/expression-evaluator/.gitignore
deleted file mode 100644
index 7b6772c..0000000
--- a/expression-evaluator/.gitignore
+++ /dev/null
@@ -1,10 +0,0 @@
-.idea/**
-.project
-.classpath
-.settings
-.java-version
-target
-.DS_Store
-.site-content
-out
-*.iml
diff --git a/expression-evaluator/pom.xml b/expression-evaluator/pom.xml
index 963c0b8..120320d 100644
--- a/expression-evaluator/pom.xml
+++ b/expression-evaluator/pom.xml
@@ -47,4 +47,22 @@
</dependency>
</dependencies>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
</project>
diff --git a/graph/pom.xml b/graph/pom.xml
index 186d111..9f3d051 100644
--- a/graph/pom.xml
+++ b/graph/pom.xml
@@ -21,12 +21,13 @@
<project xmlns="http://maven.apache.org/POM/4.0.0";
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance";
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd";>
+
+ <modelVersion>4.0.0</modelVersion>
<parent>
<artifactId>archiva-components</artifactId>
<groupId>org.apache.archiva.components</groupId>
<version>3.0-SNAPSHOT</version>
</parent>
- <modelVersion>4.0.0</modelVersion>
<artifactId>archiva-components-graph</artifactId>
<name>Archiva Components :: Graph</name>
@@ -43,5 +44,21 @@
</dependency>
</dependencies>
-
-</project>
\ No newline at end of file
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+</project>
diff --git
a/graph/src/main/java/org/apache/archiva/components/graph/api/Graph.java
b/graph/src/main/java/org/apache/archiva/components/graph/api/Graph.java
index 24715fc..7af429e 100644
--- a/graph/src/main/java/org/apache/archiva/components/graph/api/Graph.java
+++ b/graph/src/main/java/org/apache/archiva/components/graph/api/Graph.java
@@ -90,7 +90,7 @@ public interface Graph<V extends Node<V>>
* @param label the edge label
* @param sourceNode the source node
* @param destinationNode the destination node
- * @return
+ * @return the newly created edge instance
* @throws IllegalArgumentException if a edge instance with the given id
but a different type exists already. Or if
* source or destination node is
<code>null</code>
*/
@@ -104,7 +104,7 @@ public interface Graph<V extends Node<V>>
* @param label the edge label
* @param sourceNode the source node
* @param destinationNode the destination node
- * @return
+ * @return the newly created edge instance
* @throws IllegalArgumentException if source or destination is
<code>null</code>
*/
Edge<V> addEdge( String id, String label, V sourceNode, V destinationNode
) throws IllegalArgumentException;
@@ -143,7 +143,7 @@ public interface Graph<V extends Node<V>>
/**
* Returns all nodes of the graph
*
- * @return
+ * @return the set of nodes that build the graph
*/
Set<V> getNodes( );
diff --git
a/graph/src/main/java/org/apache/archiva/components/graph/api/RelationType.java
b/graph/src/main/java/org/apache/archiva/components/graph/api/RelationType.java
index 5e93912..5db5ef1 100644
---
a/graph/src/main/java/org/apache/archiva/components/graph/api/RelationType.java
+++
b/graph/src/main/java/org/apache/archiva/components/graph/api/RelationType.java
@@ -28,7 +28,7 @@ public interface RelationType
/**
* The type name
*
- * @return
+ * @return the name of the relation
*/
String name( );
}
diff --git
a/graph/src/main/java/org/apache/archiva/components/graph/api/TraversalStatus.java
b/graph/src/main/java/org/apache/archiva/components/graph/api/TraversalStatus.java
index ee8edd0..9ed5488 100644
---
a/graph/src/main/java/org/apache/archiva/components/graph/api/TraversalStatus.java
+++
b/graph/src/main/java/org/apache/archiva/components/graph/api/TraversalStatus.java
@@ -102,7 +102,7 @@ public class TraversalStatus<V extends Node<V>>
/**
* Returns the number of detected cycles.
*
- * @return
+ * @return the number of cycles
*/
public int getCycleCount( )
{
diff --git a/graph/src/site/asciidoc/index.adoc
b/graph/src/site/asciidoc/index.adoc
new file mode 100644
index 0000000..4b16ee7
--- /dev/null
+++ b/graph/src/site/asciidoc/index.adoc
@@ -0,0 +1,49 @@
+////
+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.
+
+NOTE: For help with the syntax of this file, see:
+http://maven.apache.org/guides/mini/guide-apt-format.html
+////
+
+= Graph
+
+Simple graph implementation and utility for graph traversal.
+
+The implementation provides some base classes and interfaces for graph
modeling.
+
+A graph is build from the following components:
+
+* `Node` which represents a single node in the graph model
+* `Edge` that represents the connection between two nodes. Edges have always a
direction.
+* `Graph` which references the nodes manages the connections between nodes.
Nodes and Edges are
+ always bound to their graph implementation.
+
+The `Traversal` utility allows to traverse the graph using depth-first or
breadth-first algorithms.
+It is also able to find loops in the graph.
+
+Nodes can be flagged by categories to easily build subgraphs of certain nodes.
+
+Edges always have a Label, that describes the purpose of the connection.
+
+The implementations provided here are basic implementations and provide no
special functionality like
+search or indexing.
+
+
+
+
+
+
diff --git a/graph/src/main/site/site.xml b/graph/src/site/site.xml
similarity index 100%
rename from graph/src/main/site/site.xml
rename to graph/src/site/site.xml
diff --git a/pom.xml b/pom.xml
index b79dbc2..d852740 100644
--- a/pom.xml
+++ b/pom.xml
@@ -379,6 +379,8 @@
</execution>
</executions>
</plugin>
+
+
</plugins>
</build>
@@ -398,8 +400,44 @@
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
- <version>${jxrVersion}</version>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <version>${javadocPluginVersion}</version>
+ <inherited>false</inherited>
+ <configuration>
+ <notimestamp>true</notimestamp>
+ <javadocVersion>${javaFullVersion}</javadocVersion>
+ <source>${compiler.source}</source>
+ <doclint>none</doclint>
+ <links>
+ <link>https://docs.oracle.com/javase/8/docs/api</link>
+
<link>http://commons.apache.org/collections/apidocs-COLLECTIONS_3_0/</link>
+ <link>http://commons.apache.org/dbcp/apidocs/</link>
+ <link>http://commons.apache.org/fileupload/apidocs/</link>
+ <link>http://commons.apache.org/httpclient/apidocs/</link>
+ <link>http://commons.apache.org/logging/apidocs/</link>
+ <link>http://commons.apache.org/pool/apidocs/</link>
+
<link>http://logging.apache.org/log4j/${log4j.version}/apidocs/</link>
+ <link>http://jakarta.apache.org/regexp/apidocs/</link>
+ </links>
+
+ <linksource>true</linksource>
+ <show>private</show>
+ <tags>
+ <tag>
+ <name>todo</name>
+ <placement>a</placement>
+ <head>To Do:</head>
+ </tag>
+ </tags>
+ </configuration>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
</plugin>
</plugins>
</reporting>
diff --git a/spring-apacheds/pom.xml b/spring-apacheds/pom.xml
index 4cfc2fd..580c6ab 100644
--- a/spring-apacheds/pom.xml
+++ b/spring-apacheds/pom.xml
@@ -121,4 +121,23 @@
<scope>test</scope>
</dependency>
</dependencies>
+
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
</project>
diff --git a/spring-cache/pom.xml b/spring-cache/pom.xml
index 97e4ad8..7ca2764 100644
--- a/spring-cache/pom.xml
+++ b/spring-cache/pom.xml
@@ -54,11 +54,11 @@
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
<reportSets>
<reportSet>
<id>aggregate</id>
- <inherited>false</inherited>
<reports>
<report>aggregate</report>
</reports>
@@ -67,4 +67,5 @@
</plugin>
</plugins>
</reporting>
+
</project>
diff --git
a/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/builder/CacheBuilder.java
b/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/builder/CacheBuilder.java
index b55234b..bd99517 100644
---
a/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/builder/CacheBuilder.java
+++
b/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/builder/CacheBuilder.java
@@ -32,13 +32,13 @@ public interface CacheBuilder<V, T>
{
/**
* @param roleHint
- * @return
+ * @return the cache instance
*/
Cache<V, T> getCache( String roleHint );
/**
* @param clazz
- * @return
+ * @return the cache instance
*/
Cache<V, T> getCache( Class clazz );
diff --git
a/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/factory/CacheCreator.java
b/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/factory/CacheCreator.java
index 4639a19..bb55a5e 100644
---
a/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/factory/CacheCreator.java
+++
b/spring-cache/spring-cache-api/src/main/java/org/apache/archiva/components/cache/factory/CacheCreator.java
@@ -33,7 +33,7 @@ public interface CacheCreator
/**
* Create a Cache, initialize it, and return it.
*
- * @param cacheHint the cache hints to use.
+ * @param hints the cache hints to use.
* @return the created cache.
* @throws CacheException if there was a cache creation error.
*/
diff --git
a/spring-cache/spring-cache-providers/spring-cache-hashmap/src/main/java/org/apache/archiva/components/cache/hashmap/HashMapCache.java
b/spring-cache/spring-cache-providers/spring-cache-hashmap/src/main/java/org/apache/archiva/components/cache/hashmap/HashMapCache.java
index 27ad493..7b206ea 100644
---
a/spring-cache/spring-cache-providers/spring-cache-hashmap/src/main/java/org/apache/archiva/components/cache/hashmap/HashMapCache.java
+++
b/spring-cache/spring-cache-providers/spring-cache-hashmap/src/main/java/org/apache/archiva/components/cache/hashmap/HashMapCache.java
@@ -343,7 +343,7 @@ public class HashMapCache<V, T>
}
/**
- * @return
+ * @return true, if the cache is available, otherwise false
*/
protected boolean isCacheAvailable( )
{
diff --git a/spring-registry/pom.xml b/spring-registry/pom.xml
index cac3926..f4e2ddb 100644
--- a/spring-registry/pom.xml
+++ b/spring-registry/pom.xml
@@ -83,44 +83,16 @@
</dependency>
</dependencies>
</dependencyManagement>
- <dependencies>
-
- </dependencies>
-
- <build>
- <pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-release-plugin</artifactId>
- <configuration>
- <preparationGoals>clean install</preparationGoals>
- </configuration>
- </plugin>
- </plugins>
- </pluginManagement>
- <plugins>
- <plugin>
- <groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-compiler-plugin</artifactId>
- <version>3.8.0</version>
- <configuration>
- <source>${compiler.source}</source>
- <target>${compiler.target}</target>
- </configuration>
- </plugin>
- </plugins>
- </build>
<reporting>
<plugins>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
- <artifactId>maven-jxr-plugin</artifactId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
<reportSets>
<reportSet>
<id>aggregate</id>
- <inherited>false</inherited>
<reports>
<report>aggregate</report>
</reports>
diff --git
a/spring-registry/spring-registry-api/src/main/java/org/apache/archiva/components/registry/Registry.java
b/spring-registry/spring-registry-api/src/main/java/org/apache/archiva/components/registry/Registry.java
index 9291b99..bf5c4ca 100644
---
a/spring-registry/spring-registry-api/src/main/java/org/apache/archiva/components/registry/Registry.java
+++
b/spring-registry/spring-registry-api/src/main/java/org/apache/archiva/components/registry/Registry.java
@@ -216,8 +216,9 @@ public interface Registry
* Add a change listener. Note that settings this on the base registry
will only detect 'invalidation' events, not
* individual changes. You should retrieve the named sub-registry to
listen for changes.
*
+ * TODO: this isn't ideal, so maybe fix combined configuration to re-fire
it's events to it's own listeners in the c-c implementation
+ *
* @param listener the listener
- * @todo this isn't ideal, so maybe fix combined configuration to re-fire
it's events to it's own listeners in the c-c implementation
*/
void addChangeListener( RegistryListener listener );
diff --git a/spring-taskqueue/pom.xml b/spring-taskqueue/pom.xml
index e305213..6446680 100644
--- a/spring-taskqueue/pom.xml
+++ b/spring-taskqueue/pom.xml
@@ -94,4 +94,22 @@
</dependency>
</dependencies>
+ <reporting>
+ <plugins>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <inherited>false</inherited>
+ <reportSets>
+ <reportSet>
+ <id>aggregate</id>
+ <reports>
+ <report>aggregate</report>
+ </reports>
+ </reportSet>
+ </reportSets>
+ </plugin>
+ </plugins>
+ </reporting>
+
</project>
diff --git a/graph/src/main/site/asciidoc/index.adoc
b/spring-taskqueue/src/site/asciidoc/index.adoc
similarity index 80%
rename from graph/src/main/site/asciidoc/index.adoc
rename to spring-taskqueue/src/site/asciidoc/index.adoc
index 1736ef3..0405c3e 100644
--- a/graph/src/main/site/asciidoc/index.adoc
+++ b/spring-taskqueue/src/site/asciidoc/index.adoc
@@ -19,7 +19,11 @@ NOTE: For help with the syntax of this file, see:
http://maven.apache.org/guides/mini/guide-apt-format.html
////
-Graph
-=====
+= Archiva Taskqueue
+
+This module provides a spring service that holds a queue of tasks that are
executed
+as separate threads in order.
+
+The queue allows to cancel tasks and gives information about the running
status.
+
-Simple graph implementation and utility graph for graph traversal.
diff --git a/src/site/asciidoc/index.adoc b/src/site/asciidoc/index.adoc
index 7650bf9..aab0a7e 100644
--- a/src/site/asciidoc/index.adoc
+++ b/src/site/asciidoc/index.adoc
@@ -1,5 +1,25 @@
-Archiva Components
-==================
+////
+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.
+
+NOTE: For help with the syntax of this file, see:
+http://maven.apache.org/guides/mini/guide-apt-format.html
+////
+
+= Archiva Components
Archiva Components bundles different independent component modules, that are
used by Archiva and Redback, and are free
to use by other projects.
@@ -11,4 +31,4 @@ Currently the component project contains the following
components:
- link:archiva-components-spring-apacheds/index.html[spring-apacheds]
- link:archiva-components-spring-cache/index.html[spring-cache]
- link:archiva-components-spring-registry/index.html[spring-registry]
-- link:archiva-components-spring-taskqueue[spring-taskqueue]
+- link:archiva-components-spring-taskqueue/index.html[spring-taskqueue]
diff --git a/src/site/resources/css/site.css b/src/site/resources/css/site.css
index 9a4c913..9daf77e 100644
--- a/src/site/resources/css/site.css
+++ b/src/site/resources/css/site.css
@@ -1,3 +1,24 @@
+/*
+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.
+
+NOTE: For help with the syntax of this file, see:
+http://maven.apache.org/guides/mini/guide-apt-format.html
+*/
+
@import
"https://fonts.googleapis.com/css?family=Open+Sans:300,300italic,400,400italic,600,600italic%7CNoto+Serif:400,400italic,700,700italic%7CDroid+Sans+Mono:400,700";;
.admonitionblock
td.content>.title,.audioblock>.title,.exampleblock>.title,.imageblock>.title,.listingblock>.title,.literalblock>.title,.stemblock>.title,.openblock>.title,.paragraph>.title,.quoteblock>.title,table.tableblock>.title,.verseblock>.title,.videoblock>.title,.dlist>.title,.olist>.title,.ulist>.title,.qlist>.title,.hdlist>.title{text-rendering:optimizeLegibility;text-align:left;font-family:"Noto
Serif","DejaVu Serif",serif;font-size:1rem;font-style:italic}
diff --git a/src/site/site.xml b/src/site/site.xml
index 525a202..b81e634 100644
--- a/src/site/site.xml
+++ b/src/site/site.xml
@@ -30,7 +30,7 @@
</bannerLeft>
<bannerRight>
<name>Apache Software Foundation</name>
- <src>http://www.apache.org/images/asf_logo_wide.png</src>
+ <src>http://www.apache.org/images/asf_logo_wide_2016.png</src>
<href>http://www.apache.org/</href>
</bannerRight>
