Added new Javadoc tag, mongodb.server.release, for documenting which server release added the feature on which a class or method depends

jyemin · jyemin · commit 9412bf265030 · 2014-02-03T09:14:37.000-05:00
diff --git a/build.gradle b/build.gradle
@@ -85,6 +85,7 @@ test {
     useJUnit()
     jacoco { enabled = false }
 
+
     beforeTest { descr ->
         logger.info("[Test ${descr.className} > ${descr.name}]")
     }
@@ -99,6 +100,7 @@ javadoc {
     options.tagletPath project.sourceSets.util.output.classesDir
     options.taglets 'ManualTaglet'
     options.taglets 'DochubTaglet'
+    options.taglets 'ServerReleaseTaglet'
 }
 
 gradle.taskGraph.whenReady { taskGraph ->
diff --git a/build.xml b/build.xml
@@ -218,6 +218,7 @@
             <classpath refid="build.classpath"/>
             <taglet name="DochubTaglet" path="${build.util.dir}"/>
             <taglet name="ManualTaglet" path="${build.util.dir}"/>
+            <taglet name="ServerReleaseTaglet" path="${build.util.dir}"/>
         </javadoc>
 
         <javadoc
diff --git a/src/util/DocTaglet.java b/src/util/DocTaglet.java
@@ -28,25 +28,32 @@ public abstract class DocTaglet implements Taglet {
 
     public boolean isInlineTag()   { return false; }
 
-    public String toString( Tag[] tags ){
-        if ( tags.length == 0 )
+    public String toString(Tag[] tags) {
+        if (tags.length == 0) {
             return null;
+        }
 
-        StringBuilder buf = new StringBuilder( "\n<br><DT><B>MongoDB Doc Links</B><DD>" );
-        buf.append( "<ul>" );
-        for ( Tag t : tags ){
-            buf.append( "<li>" ).append( genLink( t.text() ) ).append( "</li>" );
+        StringBuilder buf = new StringBuilder("\n");
+        buf.append("<dl><dt><span class=\"strong\">");
+        buf.append(getHeader());
+        buf.append("</span></dt>");
+        buf.append("\n");
+        for (Tag t : tags) {
+            buf.append("   <dd>").append(genLink(t.text())).append("</dd>");
         }
-        buf.append( "</ul>" );
-        buf.append( "</DD>\n" );
+        buf.append("\n");
         return buf.toString();
     }
 
-    public String toString( Tag tag ){
+    public String toString(Tag tag) {
         return toString(new Tag[]{tag});
     }
 
-    protected String genLink( String text ){
+    protected String getHeader() {
+        return "MongoDB documentation";
+    }
+
+    protected String genLink(String text) {
         String relativePath = text;
         String display = text;
 
@@ -56,9 +63,7 @@ protected String genLink( String text ){
             display = text.substring(firstSpace, text.length()).trim();
         }
 
-        return new StringBuilder()
-                .append( "<a href='" ).append(getBaseDocURI()).append(relativePath).append( "'>" ).append(display).append( "</a>" )
-                .toString();
+        return "<a href='" + getBaseDocURI() + relativePath + "'>" + display + "</a>";
     }
 
     protected abstract String getBaseDocURI();
diff --git a/src/util/ServerReleaseTaglet.java b/src/util/ServerReleaseTaglet.java
@@ -0,0 +1,27 @@
+import com.sun.javadoc.Tag;
+import com.sun.tools.doclets.Taglet;
+
+import java.util.Map;
+
+public class ServerReleaseTaglet extends DocTaglet {
+
+    public static void register(Map<String, Taglet> tagletMap) {
+        Taglet t = new ServerReleaseTaglet();
+        tagletMap.put(t.getName(), t);
+    }
+
+    @Override
+    public String getName() {
+        return "mongodb.server.release";
+    }
+
+    @Override
+    protected String getBaseDocURI() {
+        return "http://docs.mongodb.org/manual/release-notes/";
+    }
+
+    @Override
+    protected String getHeader() {
+        return "Since server release";
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -85,6 +85,7 @@ test {`
`85`	`85`	`useJUnit()`
`86`	`86`	`jacoco { enabled = false }`
`87`	`87`
	`88`	`+`
`88`	`89`	`beforeTest { descr ->`
`89`	`90`	`logger.info("[Test ${descr.className} > ${descr.name}]")`
`90`	`91`	`}`
`@@ -99,6 +100,7 @@ javadoc {`
`99`	`100`	`options.tagletPath project.sourceSets.util.output.classesDir`
`100`	`101`	`options.taglets 'ManualTaglet'`
`101`	`102`	`options.taglets 'DochubTaglet'`
	`103`	`+ options.taglets 'ServerReleaseTaglet'`
`102`	`104`	`}`
`103`	`105`
`104`	`106`	`gradle.taskGraph.whenReady { taskGraph ->`