This is an automated email from the ASF dual-hosted git repository.
hboutemy pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/maven-dependency-plugin.git
The following commit(s) were added to refs/heads/master by this push:
new 35de661 improved documentation for tree graph formats support
35de661 is described below
commit 35de6618d8cb71bffdd161f6edb196165bf6aead
Author: Hervé Boutemy <[email protected]>
AuthorDate: Wed Jul 24 20:53:48 2019 +0200
improved documentation for tree graph formats support
---
.../plugins/dependency/tree/DOTDependencyNodeVisitor.java | 3 ++-
.../dependency/tree/GraphmlDependencyNodeVisitor.java | 2 +-
.../plugins/dependency/tree/TGFDependencyNodeVisitor.java | 4 ++--
.../org/apache/maven/plugins/dependency/tree/TreeMojo.java | 13 +++++++------
src/site/apt/usage.apt.vm | 6 +++---
5 files changed, 15 insertions(+), 13 deletions(-)
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
b/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
index dea31fe..adf92e3 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/tree/DOTDependencyNodeVisitor.java
@@ -26,7 +26,8 @@ import java.io.Writer;
import java.util.List;
/**
- * A dependency node visitor that serializes visited nodes to DOT format
http://en.wikipedia.org/wiki/DOT_language
+ * A dependency node visitor that serializes visited nodes to <a
href="https://en.wikipedia.org/wiki/DOT_language";>DOT
+ * format</a>
*
* @author <a href="mailto:[email protected]";>Pi Song</a>
* @since 2.1
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
index ff08f33..372dd73 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/tree/GraphmlDependencyNodeVisitor.java
@@ -26,7 +26,7 @@ import
org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
/**
* A dependency node visitor that serializes visited nodes to a writer using
the
- * <a href="http://graphml.graphdrawing.org/";>graphml format</a>.
+ * <a href="https://en.wikipedia.org/wiki/GraphML";>graphml format</a>.
*
* @author <a href="mailto:[email protected]";>Jerome Creignou</a>
* @since 2.1
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
b/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
index 1a598c3..eb8cc0e 100644
---
a/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
+++
b/src/main/java/org/apache/maven/plugins/dependency/tree/TGFDependencyNodeVisitor.java
@@ -27,8 +27,8 @@ import
org.apache.maven.shared.dependency.graph.DependencyNode;
import
org.apache.maven.shared.dependency.graph.traversal.DependencyNodeVisitor;
/**
- * A dependency node visitor that serializes visited nodes to a writer using
the TGF format.
- * http://en.wikipedia.org/wiki/Trivial_Graph_Format
+ * A dependency node visitor that serializes visited nodes to a writer using
the
+ * <a href="https://en.wikipedia.org/wiki/Trivial_Graph_Format";>TGF format</a>.
*
* @author <a href="mailto:[email protected]";>Jerome Creignou</a>
* @since 2.1
diff --git
a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
index d8a4367..1acc162 100644
--- a/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
+++ b/src/main/java/org/apache/maven/plugins/dependency/tree/TreeMojo.java
@@ -61,7 +61,10 @@ import
org.apache.maven.shared.dependency.graph.traversal.SerializingDependencyN
import
org.apache.maven.shared.dependency.graph.traversal.SerializingDependencyNodeVisitor.GraphTokens;
/**
- * Displays the dependency tree for this project.
+ * Displays the dependency tree for this project. Multiple formats are
supported: text (by default), but also
+ * <a href="https://en.wikipedia.org/wiki/DOT_language";>DOT</a>,
+ * <a href="https://en.wikipedia.org/wiki/GraphML";>graphml</a> and
+ * <a href="https://en.wikipedia.org/wiki/Trivial_Graph_Format";>TGF</a>.
*
* @author <a href="mailto:[email protected]";>Mark Hobson</a>
* @since 2.0-alpha-5
@@ -104,10 +107,8 @@ public class TreeMojo
/**
* If specified, this parameter will cause the dependency tree to be
written using the specified format. Currently
- * supported format are: <code>text</code>, <code>dot</code>,
<code>graphml</code> and <code>tgf</code>.
- * <p/>
- * These formats can be plotted to image files. An example of how to plot
a dot file using pygraphviz can be found
- * <a
href="http://networkx.lanl.gov/pygraphviz/tutorial.html#layout-and-drawing";>here</a>.
+ * supported format are: <code>text</code> (default), <code>dot</code>,
<code>graphml</code> and <code>tgf</code>.
+ * These additional formats can be plotted to image files.
*
* @since 2.2
*/
@@ -126,7 +127,7 @@ public class TreeMojo
/**
* Whether to include omitted nodes in the serialized dependency tree.
Notice this feature actually uses Maven 2
- * algorithm and <a
href="http://maven.apache.org/shared/maven-dependency-tree/";>may give wrong
results when used
+ * algorithm and <a
href="https://maven.apache.org/shared/maven-dependency-tree/";>may give wrong
results when used
* with Maven 3</a>.
*
* @since 2.0-alpha-6
diff --git a/src/site/apt/usage.apt.vm b/src/site/apt/usage.apt.vm
index 0ccbea4..219bc67 100644
--- a/src/site/apt/usage.apt.vm
+++ b/src/site/apt/usage.apt.vm
@@ -610,11 +610,11 @@ mvn dependency:tree -Doutput=/path/to/file
* text
- * dot
+ * {{{https://en.wikipedia.org/wiki/DOT_language}dot}}
- * graphml
+ * {{{https://en.wikipedia.org/wiki/GraphML}graphml}}
- * tgf
+ * {{{https://en.wikipedia.org/wiki/Trivial_Graph_Format}tgf}}
[]
