commons-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From leosu...@apache.org
Subject svn commit: r328511 - in /jakarta/commons/proper/attributes/trunk: api/ api/src/java/org/apache/commons/attributes/ compiler/src/java/org/apache/commons/attributes/compiler/ plugin/ site/ site/xdocs/
Date Wed, 26 Oct 2005 00:04:41 GMT
Author: leosutic
Date: Tue Oct 25 17:04:25 2005
New Revision: 328511

URL: http://svn.apache.org/viewcvs?rev=328511&view=rev
Log:
 + Added ability to specify attribute packages for the
   maven plugin. (Bug 31526)
   http://issues.apache.org/bugzilla/show_bug.cgi?id=31526

 + Fixed some typos in the Javadoc

Modified:
    jakarta/commons/proper/attributes/trunk/api/project.xml
    jakarta/commons/proper/attributes/trunk/api/src/java/org/apache/commons/attributes/Attributes.java
    jakarta/commons/proper/attributes/trunk/compiler/src/java/org/apache/commons/attributes/compiler/AttributeCompiler.java
    jakarta/commons/proper/attributes/trunk/plugin/plugin.jelly
    jakarta/commons/proper/attributes/trunk/site/maven.xml
    jakarta/commons/proper/attributes/trunk/site/xdocs/changelog.xml
    jakarta/commons/proper/attributes/trunk/site/xdocs/compiler.xml

Modified: jakarta/commons/proper/attributes/trunk/api/project.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/api/project.xml?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/api/project.xml (original)
+++ jakarta/commons/proper/attributes/trunk/api/project.xml Tue Oct 25 17:04:25 2005
@@ -44,18 +44,6 @@
             <id>qdox</id>
             <version>1.5</version>
         </dependency>   
-        
-        <!--
-        <dependency>
-            <id>xdoclet+xjavadoc</id>
-            <version>1.0</version>
-        </dependency>
-        
-        <dependency>
-            <id>commons-collections</id>
-            <version>2.1</version>
-        </dependency>
-        -->
     </dependencies>
     
 </project>

Modified: jakarta/commons/proper/attributes/trunk/api/src/java/org/apache/commons/attributes/Attributes.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/api/src/java/org/apache/commons/attributes/Attributes.java?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/api/src/java/org/apache/commons/attributes/Attributes.java
(original)
+++ jakarta/commons/proper/attributes/trunk/api/src/java/org/apache/commons/attributes/Attributes.java
Tue Oct 25 17:04:25 2005
@@ -546,7 +546,7 @@
      * Tests if a class has an attribute of a given type. That is, is there any attribute
      * <code>attr</code> such that <code>attr.getClass() == attributeClass</code>?
      *
-     * @param class the class. May not be <code>null</code>.
+     * @param clazz the class. May not be <code>null</code>.
      * @param attributeClass the type of attribute. May be <code>null</code>,
but this will not match anything.
      *
      * @since 2.1
@@ -572,7 +572,7 @@
      * Tests if a constructor has an attribute of a given type. That is, is there any attribute
      * <code>attr</code> such that <code>attr.getClass() == attributeClass</code>?
      *
-     * @param ctor the constructor. May not be <code>null</code>.
+     * @param constructor the constructor. May not be <code>null</code>.
      * @param attributeClass the type of attribute. May be <code>null</code>,
but this will not match anything.
      *
      * @since 2.1

Modified: jakarta/commons/proper/attributes/trunk/compiler/src/java/org/apache/commons/attributes/compiler/AttributeCompiler.java
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/compiler/src/java/org/apache/commons/attributes/compiler/AttributeCompiler.java?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/compiler/src/java/org/apache/commons/attributes/compiler/AttributeCompiler.java
(original)
+++ jakarta/commons/proper/attributes/trunk/compiler/src/java/org/apache/commons/attributes/compiler/AttributeCompiler.java
Tue Oct 25 17:04:25 2005
@@ -473,7 +473,6 @@
     public void execute () throws BuildException {
         destDir.mkdirs ();
         numGenerated = 0;
-        
         try {
             JavaDocBuilder builder = new JavaDocBuilder ();
             for (int i = 0; i < fileSets.size (); i++) {

Modified: jakarta/commons/proper/attributes/trunk/plugin/plugin.jelly
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/plugin/plugin.jelly?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/plugin/plugin.jelly (original)
+++ jakarta/commons/proper/attributes/trunk/plugin/plugin.jelly Tue Oct 25 17:04:25 2005
@@ -37,7 +37,8 @@
         <ant:mkdir dir="${maven.build.dir}/commons-attributes"/>
 
         <ant:attribute-compiler inMaven="true" sourcepathref="maven.compile.src.set"
-            destdir="${maven.build.dir}/commons-attributes"/>
+            destdir="${maven.build.dir}/commons-attributes"
+            attributepackages="${org.apache.commons.attributes.attributepackages}"/>
 
         <ant:path 
             id="jakarta.commons.attributes.generated.dir" 
@@ -70,7 +71,8 @@
         <ant:attribute-compiler 
             inMaven="true" 
             sourcepathref="maven.test.compile.src.set"
-            destdir="${maven.build.dir}/commons-attributes-unittest"/>
+            destdir="${maven.build.dir}/commons-attributes-unittest"
+            attributepackages="${org.apache.commons.attributes.attributepackages}"/>
 
         <ant:path 
             id="jakarta.commons.attributes.generated.dir.test" 

Modified: jakarta/commons/proper/attributes/trunk/site/maven.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/site/maven.xml?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/site/maven.xml (original)
+++ jakarta/commons/proper/attributes/trunk/site/maven.xml Tue Oct 25 17:04:25 2005
@@ -30,7 +30,8 @@
     </preGoal>
     
     <goal name="attributes:site">
-        <attainGoal name="site:generate"/>
+        <echo>---</echo>
+        <attainGoal name="xdoc:transform"/>
     </goal>
     
     <preGoal name="xdoc:copy-user-resources">

Modified: jakarta/commons/proper/attributes/trunk/site/xdocs/changelog.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/site/xdocs/changelog.xml?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/site/xdocs/changelog.xml (original)
+++ jakarta/commons/proper/attributes/trunk/site/xdocs/changelog.xml Tue Oct 25 17:04:25 2005
@@ -24,6 +24,40 @@
     </properties>
     
     <body>
+        <section name="2005-10-26">
+            <ul>
+                <li>
+                    <p>
+                        Added support for attribute packages (<a href="http://issues.apache.org/bugzilla/show_bug.cgi?id=31526">Bug
31526</a>):
+                    </p>
+                    
+                    <blockquote>
+                        <p>When the ant:attribute-compiler is used in ant, there is
no way for maven to
+                            pass a value for the attributepackages property.</p>
+                        
+                        <p>It would be nice if it were possible to add a property in
the project.properties
+                            of the current project that specifies the attributepackages.
E.g.</p>
+                        
+                        <source><![CDATA[project.properties:
+[...]
+org.apache.commons.attributes.packages=my.package
+[...]]></source>
+                        
+                        <p>which is then used in the maven plugin:</p>
+                        
+                        <source><![CDATA[[...]
+<ant:attribute-compiler inMaven="true" sourcepathref="maven.compile.src.set"
+    attributepackages="${org.apache.commons.attributes.packages}"
+    destdir="${maven.build.dir}/commons-attributes"/>
+[...]]]></source>
+                        
+                    </blockquote>
+                    <p>And that is exactly what was implemented.</p>
+                </li>
+            </ul>
+        </section>
+        
+        
         <section name="2004-09-11">
             <ul>
                 <li>
@@ -31,7 +65,7 @@
                         <span style="color: #a00000; font-weight:bold;">BUG:</span>
Checks for Target specifications would go unnoticed for attributes
                         attached to fields, methods and constructors. The following code
would
                         <b>not</b> result in an <a href="api/org/apache/commons/attributes/InvalidAttributeTargetError.html">InvalidAttributeTargetError</a>.
-                    The bug is fixed in current CVS.
+                        The bug is fixed in current CVS.
                     </p>
                     
                     <source><![CDATA[/**
@@ -48,7 +82,7 @@
                 </li>
             </ul>
         </section>
-  
+        
         <section name="2004-09-10">
             <ul>
                 <li>

Modified: jakarta/commons/proper/attributes/trunk/site/xdocs/compiler.xml
URL: http://svn.apache.org/viewcvs/jakarta/commons/proper/attributes/trunk/site/xdocs/compiler.xml?rev=328511&r1=328510&r2=328511&view=diff
==============================================================================
--- jakarta/commons/proper/attributes/trunk/site/xdocs/compiler.xml (original)
+++ jakarta/commons/proper/attributes/trunk/site/xdocs/compiler.xml Tue Oct 25 17:04:25 2005
@@ -118,6 +118,33 @@
             </p>
             
         </section>
+        
+        <section name="How Do I Use It With Maven?">
+            <p>
+                If you use Maven you can just install the Commons-Attributes plugin and add
the following lines
+                to your project.properties:
+            </p>
+                
+                <source><![CDATA[######################################################################
+# Commons-Attributes
+######################################################################
+org.apache.commons.attributes.enable=true
+
+#
+# Optional, enables attribute indexing
+#
+org.apache.commons.attributes.index.enable=true
+
+#
+# Optional, equivalent to specifying attributepackages for the compiler
+#
+org.apache.commons.attributes.attributepackages=mypackage;myotherpackage]]></source>
+                
+                <p>
+                    Attribute compilation will happen automatically.
+                </p>
+        </section>
+        
     </body>
     
 </document>



---------------------------------------------------------------------
To unsubscribe, e-mail: commons-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: commons-dev-help@jakarta.apache.org


Mime
View raw message