You are viewing a plain text version of this content. The canonical link for it is here.
Posted to cvs@depot.apache.org by ni...@apache.org on 2004/08/09 22:47:14 UTC
svn commit: rev 36134 - in incubator/depot/trunk/version/src: java/org/apache/depot/version/generation templates
Author: nickchalko
Date: Mon Aug 9 15:47:13 2004
New Revision: 36134
Modified:
incubator/depot/trunk/version/src/java/org/apache/depot/version/generation/VersionSourceGenerator.java
incubator/depot/trunk/version/src/templates/VersionSourceGenerator.java.jet
Log:
Improved Generate javadocs.
Modified: incubator/depot/trunk/version/src/java/org/apache/depot/version/generation/VersionSourceGenerator.java
==============================================================================
--- incubator/depot/trunk/version/src/java/org/apache/depot/version/generation/VersionSourceGenerator.java (original)
+++ incubator/depot/trunk/version/src/java/org/apache/depot/version/generation/VersionSourceGenerator.java Mon Aug 9 15:47:13 2004
@@ -54,24 +54,29 @@
protected final String TEXT_28 = " was built at ";
protected final String TEXT_29 = "." + NL + "\t * @return the Date \"";
protected final String TEXT_30 = "\"" + NL + "\t */" + NL + "\tpublic Date getDate() {return ";
- protected final String TEXT_31 = "; }" + NL + "\t" + NL + "\t/**" + NL + "\t * The ID of the Version Specification." + NL + "\t * @return ID of the Version Specification." + NL + "\t * @see org.apache.depot.version.specification.VersionSpecificationFactory" + NL + "\t */" + NL + "\tpublic String getSpecificationId(){return \"";
- protected final String TEXT_32 = "\";} " + NL + "\t" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
- protected final String TEXT_33 = " ";
- protected final String TEXT_34 = "." + NL + "\t * @return the String \"";
- protected final String TEXT_35 = "\"" + NL + "\t */" + NL + "\tpublic String getShortVersion() {return \"";
- protected final String TEXT_36 = "\";}" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
- protected final String TEXT_37 = " ";
- protected final String TEXT_38 = "." + NL + "\t * @return the String \"";
- protected final String TEXT_39 = "\"" + NL + "\t */" + NL + "\tpublic String getLongVersion() {return \"";
- protected final String TEXT_40 = "\";}" + NL + "" + NL + "\t/**" + NL + "\t * ";
- protected final String TEXT_41 = " ";
- protected final String TEXT_42 = "." + NL + "\t * @return the String \"";
- protected final String TEXT_43 = "\"" + NL + "\t */" + NL + "\tpublic String getDefaultVersion() {return \"";
- protected final String TEXT_44 = "\";}\t" + NL + "" + NL + "" + NL + "\tpublic Map getAttributes () {" + NL + "\t return attributes;" + NL + "\t}" + NL + "" + NL + "" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
- protected final String TEXT_45 = " ";
- protected final String TEXT_46 = "." + NL + "\t * @return the String \"";
- protected final String TEXT_47 = "\"" + NL + "\t */" + NL + "\tpublic String toString() {return \"";
- protected final String TEXT_48 = "\";}" + NL + "} ";
+ protected final String TEXT_31 = "; }" + NL + "\t" + NL + "\t/**" + NL + "\t * The ID of the Version Specification." + NL + "\t * @return the String \"";
+ protected final String TEXT_32 = "\"." + NL + "\t * @see org.apache.depot.version.specification.VersionSpecificationFactory" + NL + "\t */" + NL + "\tpublic String getSpecificationId(){return \"";
+ protected final String TEXT_33 = "\";} " + NL + "\t" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
+ protected final String TEXT_34 = " ";
+ protected final String TEXT_35 = "." + NL + "\t * @return the String \"";
+ protected final String TEXT_36 = "\"" + NL + "\t */" + NL + "\tpublic String getShortVersion() {return \"";
+ protected final String TEXT_37 = "\";}" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
+ protected final String TEXT_38 = " ";
+ protected final String TEXT_39 = "." + NL + "\t * @return the String \"";
+ protected final String TEXT_40 = "\"" + NL + "\t */" + NL + "\tpublic String getLongVersion() {return \"";
+ protected final String TEXT_41 = "\";}" + NL + "" + NL + "\t/**" + NL + "\t * ";
+ protected final String TEXT_42 = " ";
+ protected final String TEXT_43 = "." + NL + "\t * @return the String \"";
+ protected final String TEXT_44 = "\"" + NL + "\t */" + NL + "\tpublic String getDefaultVersion() {return \"";
+ protected final String TEXT_45 = "\";}\t" + NL + "" + NL + "\t/**" + NL + "\t * Get the Unmodifiable map of attributes. \t" + NL + "\t * <dl>";
+ protected final String TEXT_46 = NL + " * <dt>";
+ protected final String TEXT_47 = "</dt>" + NL + " * <dd>";
+ protected final String TEXT_48 = "</dd>";
+ protected final String TEXT_49 = NL + " * </dl>" + NL + "\t * @return unmodifiable Map of attributes." + NL + "\t */" + NL + "\tpublic Map getAttributes () {return attributes;}" + NL + "" + NL + "" + NL + "\t" + NL + "\t/**" + NL + "\t * ";
+ protected final String TEXT_50 = " ";
+ protected final String TEXT_51 = "." + NL + "\t * @return the String \"";
+ protected final String TEXT_52 = "\"" + NL + "\t */" + NL + "\tpublic String toString() {return \"";
+ protected final String TEXT_53 = "\";}" + NL + "} ";
public String generate(String packageName, String className, VersionMarker marker)
{
@@ -144,38 +149,53 @@
stringBuffer.append(TEXT_31);
stringBuffer.append(marker.getSpecification().getId());
stringBuffer.append(TEXT_32);
- stringBuffer.append(marker.getId());
+ stringBuffer.append(marker.getSpecification().getId());
stringBuffer.append(TEXT_33);
- stringBuffer.append(marker.getShortVersion());
+ stringBuffer.append(marker.getId());
stringBuffer.append(TEXT_34);
stringBuffer.append(marker.getShortVersion());
stringBuffer.append(TEXT_35);
stringBuffer.append(marker.getShortVersion());
stringBuffer.append(TEXT_36);
- stringBuffer.append(marker.getId());
+ stringBuffer.append(marker.getShortVersion());
stringBuffer.append(TEXT_37);
- stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(marker.getId());
stringBuffer.append(TEXT_38);
stringBuffer.append(marker.getLongVersion());
stringBuffer.append(TEXT_39);
stringBuffer.append(marker.getLongVersion());
stringBuffer.append(TEXT_40);
- stringBuffer.append(marker.getId());
+ stringBuffer.append(marker.getLongVersion());
stringBuffer.append(TEXT_41);
- stringBuffer.append(marker.getDefaultVersion());
+ stringBuffer.append(marker.getId());
stringBuffer.append(TEXT_42);
stringBuffer.append(marker.getDefaultVersion());
stringBuffer.append(TEXT_43);
stringBuffer.append(marker.getDefaultVersion());
stringBuffer.append(TEXT_44);
- stringBuffer.append(marker.getId());
+ stringBuffer.append(marker.getDefaultVersion());
stringBuffer.append(TEXT_45);
- stringBuffer.append(marker.getLongVersion());
+
+ for (Iterator i = marker.getAttributes().entrySet().iterator(); i.hasNext();) {
+ Map.Entry entry = (Map.Entry) i.next();
+ // TODO need to escape key and value.
+
stringBuffer.append(TEXT_46);
- stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(entry.getKey());
stringBuffer.append(TEXT_47);
- stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(entry.getValue());
stringBuffer.append(TEXT_48);
+
+ }
+ stringBuffer.append(TEXT_49);
+ stringBuffer.append(marker.getId());
+ stringBuffer.append(TEXT_50);
+ stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(TEXT_51);
+ stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(TEXT_52);
+ stringBuffer.append(marker.getLongVersion());
+ stringBuffer.append(TEXT_53);
return stringBuffer.toString();
}
}
Modified: incubator/depot/trunk/version/src/templates/VersionSourceGenerator.java.jet
==============================================================================
--- incubator/depot/trunk/version/src/templates/VersionSourceGenerator.java.jet (original)
+++ incubator/depot/trunk/version/src/templates/VersionSourceGenerator.java.jet Mon Aug 9 15:47:13 2004
@@ -102,13 +102,16 @@
public String getDefaultVersion() {return "<%=marker.getDefaultVersion()%>";}
/**
- * Get the Unmodifiable map of attributes. <%
+ * Get the Unmodifiable map of attributes.
+ * <dl><%
for (Iterator i = marker.getAttributes().entrySet().iterator(); i.hasNext();) {
Map.Entry entry = (Map.Entry) i.next();
// TODO need to escape key and value.
%>
- * <%=getValueFrom(entry.getKey())%> = <%=entry.getValue()%><%
+ * <dt><%=entry.getKey()%></dt>
+ * <dd><%=entry.getValue()%></dd><%
}%>
+ * </dl>
* @return unmodifiable Map of attributes.
*/
public Map getAttributes () {return attributes;}