Author: dennisl
Date: Sat Mar 15 07:02:22 2008
New Revision: 637410
URL: http://svn.apache.org/viewvc?rev=637410&view=rev
Log:
o Improve Javadoc.
Modified:
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
Modified:
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
URL:
http://svn.apache.org/viewvc/maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java?rev=637410&r1=637409&r2=637410&view=diff
==============================================================================
---
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
(original)
+++
maven/shared/trunk/maven-doxia-tools/src/main/java/org/apache/maven/doxia/tools/SiteTool.java
Sat Mar 15 07:02:22 2008
@@ -70,14 +70,18 @@
throws SiteToolException;
/**
+ * Calculate the relative path between two URL:s or between two files.
+ *
* For example:
* <dl>
- * <dt>to = "http://maven.apache.org"; and from =
"http://maven.apache.org";</dl>
+ * <dt>to = "http://maven.apache.org"; and from =
"http://maven.apache.org";</dt>
* <dd>return ""</dd>
- * <dt>to = "http://maven.apache.org"; and from =
"http://maven.apache.org/plugins/maven-site-plugin/";</dl>
+ * <dt>to = "http://maven.apache.org"; and from =
"http://maven.apache.org/plugins/maven-site-plugin/";</dt>
* <dd>return "../.."</dd>
- * <dt>to = "http://maven.apache.org/plugins/maven-site-plugin/"; and from
= "http://maven.apache.org";</dl>
+ * <dt>to = "http://maven.apache.org/plugins/maven-site-plugin/"; and from
= "http://maven.apache.org";</dt>
* <dd>return "plugins/maven-site-plugin"</dd>
+ * <dt>to = "/myproject/myproject-module1" and from =
"/myproject/myproject"</dt>
+ * <dd>return "../myproject-module1"</dd>
* </dl>
* <b>Note</b>: The file separator depends on the system.
*
