You are viewing a plain text version of this content. The canonical link for it is here.

Posted to commits@abdera.apache.org by jm...@apache.org on 2007/11/27 01:45:03 UTC

svn commit: r598480 - in /incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates: URITemplate.java VarName.java

Author: jmsnell
Date: Mon Nov 26 16:45:02 2007
New Revision: 598480

URL: http://svn.apache.org/viewvc?rev=598480&view=rev
Log:
Some javadocs

Modified:
    incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/URITemplate.java
    incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/VarName.java

Modified: incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/URITemplate.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/URITemplate.java?rev=598480&r1=598479&r2=598480&view=diff
==============================================================================
--- incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/URITemplate.java (original)
+++ incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/URITemplate.java Mon Nov 26 16:45:02 2007
@@ -23,6 +23,13 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * The URITemplate annotation can be used to associate a URI Template with a
+ * particular Java class.  Instances of that class can then be expanded using
+ * the associated URI Template.  The public fields and getter methods on the 
+ * class will be automatically mapped to URI Template variable names. Alternative
+ * varnames can be specified for each field/getter using the VarName annotation
+ */
 @Retention(RUNTIME)
 @Target(TYPE)
 public @interface URITemplate {

Modified: incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/VarName.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/VarName.java?rev=598480&r1=598479&r2=598480&view=diff
==============================================================================
--- incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/VarName.java (original)
+++ incubator/abdera/java/trunk/dependencies/i18n/src/main/java/org/apache/abdera/i18n/templates/VarName.java Mon Nov 26 16:45:02 2007
@@ -24,6 +24,9 @@
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
+/**
+ * Used to specify an alternative URI Template varname for a field or method
+ */
 @Retention(RUNTIME)
 @Target({FIELD,METHOD})
 public @interface VarName {