You are viewing a plain text version of this content. The canonical link for it is here.
Posted to ivy-commits@incubator.apache.org by xa...@apache.org on 2007/06/28 13:13:52 UTC
svn commit: r551548 - in /incubator/ivy/core/trunk: ./
src/java/org/apache/ivy/ant/ src/java/org/apache/ivy/core/deliver/
src/java/org/apache/ivy/core/module/descriptor/
src/java/org/apache/ivy/core/module/id/ src/java/org/apache/ivy/core/report/
Author: xavier
Date: Thu Jun 28 06:13:51 2007
New Revision: 551548
URL: http://svn.apache.org/viewvc?view=rev&rev=551548
Log:
IMPROVEMENT: Javadoc improvements (IVY-544) (thanks to Tjeerd Verhagen)
Modified:
incubator/ivy/core/trunk/CHANGES.txt
incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyAntSettings.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyPublish.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/deliver/PublishingDependencyRevisionResolver.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ArtifactId.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ModuleId.java
incubator/ivy/core/trunk/src/java/org/apache/ivy/core/report/ResolveReport.java
Modified: incubator/ivy/core/trunk/CHANGES.txt
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/CHANGES.txt?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/CHANGES.txt (original)
+++ incubator/ivy/core/trunk/CHANGES.txt Thu Jun 28 06:13:51 2007
@@ -45,6 +45,7 @@
Andreas Sahlbach
John Shields
Johan Stuyts
+ Tjeerd Verhagen
John Williams
Jaroslaw Wypychowski
@@ -59,6 +60,7 @@
- IMPROVEMENT: Remove @author tags (thanks to Stephane Bailliez)
- IMPROVEMENT: Remove use of deprecated elements in ivysettings.xml (IVY-505) (with contribution from Jan Materne)
- IMPROVEMENT: Buildlist onlydirectdep attribute (IVY-473 and IVY-504) (with contribution from Mikkel Bjerg )
+- IMPROVEMENT: Javadoc improvements (IVY-544) (thanks to Tjeerd Verhagen)
- FIX: Evicted modules report depends on the order of the dependencies (IVY-526)
- FIX: Ivy does not work on Turkish machines (IVY-65)
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyAntSettings.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyAntSettings.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyAntSettings.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyAntSettings.java Thu Jun 28 06:13:51 2007
@@ -99,8 +99,8 @@
* Returns the default ivy settings of this classloader. If it doesn't exist yet, a new one is
* created using the given project to back the VariableContainer.
*
- * @param project
- * @return
+ * @param project TODO add text.
+ * @return An IvySetting instance.
*/
public static IvyAntSettings getDefaultInstance(Project project) {
Object defaultInstanceObj = project.getReference("ivy.instance");
@@ -201,7 +201,8 @@
*/
/**
- * @return
+ * Return the configured Ivy instance.
+ * @return Returns the configured Ivy instance.
*/
public Ivy getConfiguredIvyInstance() {
if (ivyEngine == null) {
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyPublish.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyPublish.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyPublish.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/ant/IvyPublish.java Thu Jun 28 06:13:51 2007
@@ -101,16 +101,14 @@
}
/**
- * @deprecated use getSrcivypattern instead
- * @return
+ * @deprecated use {@link #getSrcivypattern()} instead.
*/
public String getDeliverivypattern() {
return srcivypattern;
}
/**
- * @deprecated use setSrcivypattern instead
- * @return
+ * @deprecated use {@link #setSrcivypattern(String)} instead.
*/
public void setDeliverivypattern(String destivypattern) {
srcivypattern = destivypattern;
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/deliver/PublishingDependencyRevisionResolver.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/deliver/PublishingDependencyRevisionResolver.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/deliver/PublishingDependencyRevisionResolver.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/deliver/PublishingDependencyRevisionResolver.java Thu Jun 28 06:13:51 2007
@@ -31,10 +31,11 @@
*
* @param published
* @param publishedStatus
- * @param dependency
+ * @param depMrid
+ * @param status
* @return the revision of the dependency
*/
- String resolve(ModuleDescriptor published, String publishedStatus, ModuleRevisionId depMrid,
+ String resolve(ModuleDescriptor published, String publishedStatus, ModuleRevisionId depMrid,
String status);
}
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/Artifact.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/Artifact.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/Artifact.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/Artifact.java Thu Jun 28 06:13:51 2007
@@ -26,8 +26,8 @@
/**
* Representation of a published 'file' in the development environment. An artifact is generally a
- * file that is produced by a project build. This is typically a jar, a war, an ear, a zip, a deb,
- * ...
+ * file that is produced by a project build. This is typically a <code>jar</code>, a <code>war</code>,
+ * an <code>ear</code>, a <code>zip</code>, a <code>deb</code>, etc.
*/
public interface Artifact extends ExtendableItem {
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/descriptor/ModuleDescriptor.java Thu Jun 28 06:13:51 2007
@@ -76,14 +76,14 @@
String getStatus();
/**
- * may be null if unknown in the descriptor itself
+ * May be <code>null</code> if unknown in the descriptor itself.
*
- * @return
+ * @return The publication date or <code>null</code> when not knwon.
*/
Date getPublicationDate();
/**
- * the publication date of the module revision should be the date at which it has been
+ * The publication date of the module revision should be the date at which it has been
* published, i.e. in general the date of any of its published artifacts, since all published
* artifact of a module should follow the same publishing cycle.
*/
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ArtifactId.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ArtifactId.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ArtifactId.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ArtifactId.java Thu Jun 28 06:13:51 2007
@@ -30,9 +30,9 @@
private String ext;
/**
- * @param mid
- * @param name
- * @param type
+ * @param mid The ModuleId, which is the base of this artifact.
+ * @param name The name of the artifact.
+ * @param type The type of the artifact.
*/
public ArtifactId(ModuleId mid, String name, String type, String ext) {
this.mid = mid;
@@ -41,6 +41,7 @@
this.ext = ext;
}
+ /** {@inheritDoc} */
public boolean equals(Object obj) {
if (!(obj instanceof ArtifactId)) {
return false;
@@ -50,6 +51,7 @@
&& getExt().equals(aid.getExt()) && getType().equals(aid.getType());
}
+ /** {@inheritDoc} */
public int hashCode() {
//CheckStyle:MagicNumber| OFF
int hash = 17;
@@ -60,6 +62,7 @@
return hash;
}
+ /** {@inheritDoc} */
public String toString() {
return getModuleId() + " " + getName() + "." + getType();
}
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ModuleId.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ModuleId.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ModuleId.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/module/id/ModuleId.java Thu Jun 28 06:13:51 2007
@@ -29,6 +29,11 @@
private int hash;
+ /**
+ * Constructor.
+ * @param organisation The organisation which creates the module.
+ * @param name The name of the module.
+ */
public ModuleId(String organisation, String name) {
if (name == null) {
throw new IllegalArgumentException("null name not allowed");
@@ -37,14 +42,23 @@
this.name = name;
}
+ /**
+ * Returns the name of the module.
+ * @return The name of the module.
+ */
public String getName() {
return name;
}
+ /**
+ * Returns the name of the organisation.
+ * @return The name of the organisation.
+ */
public String getOrganisation() {
return organisation;
}
+ /** {@inheritDoc} */
public boolean equals(Object obj) {
if (!(obj instanceof ModuleId)) {
return false;
@@ -57,6 +71,7 @@
}
}
+ /** {@inheritDoc} */
public int hashCode() {
if (hash == 0) {
//CheckStyle:MagicNumber| OFF
@@ -68,11 +83,12 @@
return hash;
}
-
+ /** {@inheritDoc} */
public String toString() {
return "[ " + organisation + " | " + name + " ]";
}
+ /** {@inheritDoc} */
public int compareTo(Object obj) {
ModuleId that = (ModuleId) obj;
int result = organisation.compareTo(that.organisation);
@@ -82,10 +98,20 @@
return result;
}
+ /**
+ * Returns the encoded String representing this ModuleId.
+ * @return The ModuleId encoded as String.
+ */
public String encodeToString() {
return getOrganisation() + ENCODE_SEPARATOR + getName();
}
+ /**
+ * Returns a ModuleId
+ * @param encoded
+ * @return The new ModuleId.
+ * @throws IllegalArgumentException If the given String could not be decoded.
+ */
public static ModuleId decode(String encoded) {
String[] parts = encoded.split(ENCODE_SEPARATOR);
if (parts.length != 2) {
Modified: incubator/ivy/core/trunk/src/java/org/apache/ivy/core/report/ResolveReport.java
URL: http://svn.apache.org/viewvc/incubator/ivy/core/trunk/src/java/org/apache/ivy/core/report/ResolveReport.java?view=diff&rev=551548&r1=551547&r2=551548
==============================================================================
--- incubator/ivy/core/trunk/src/java/org/apache/ivy/core/report/ResolveReport.java (original)
+++ incubator/ivy/core/trunk/src/java/org/apache/ivy/core/report/ResolveReport.java Thu Jun 28 06:13:51 2007
@@ -187,7 +187,7 @@
* Returns the list of all dependencies concerned by this report as a List of IvyNode ordered
* from the more dependent to the least one
*
- * @return
+ * @return The list of all dependencies.
*/
public List getDependencies() {
return dependencies;
@@ -197,7 +197,7 @@
* Returns the list of all artifacts which should be downloaded per this resolve To know if the
* artifact have actually been downloaded use information found in ConfigurationResolveReport.
*
- * @return
+ * @return The list of all artifacts.
*/
public List getArtifacts() {
return artifacts;