You are viewing a plain text version of this content. The canonical link for it is here.
Posted to users@maven.apache.org by Maarten Coene <Ma...@Toughguy.net> on 2003/06/06 11:33:51 UTC

tasklist plugin help needed

Hi,

I want to use the tasklist plugin, but the plugin doesn't find any todo's 
in my source code. For my todo's, I use the "@todo" tag in the javadoc of 
my method, e.g.:

/**
  * The description of my method
  * @todo Refactor this method
  */
  public void myMethod() { ... }

I tried to generate the todo list with "maven tasklist" .

What should I do to get the tasklist plugin generate a todo list?

thx
Maarten Coene




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: tasklist plugin help needed

Posted by Martin Skopp <sk...@riege.de>.
Hi task-list developers, please listen:

On Tue, 2003-06-10 at 02:37, Gabriel Sjoberg wrote:
> maven.tasklist.taskTag = <your tag here>
> 
> [..] Perhaps case-insensitivity can be added to a future version of the plugin.

I would prefer a regular expression...
Would be easier to program as well
-- 
Martin Skopp
Riege Software International GmbH
Support: mailto:maint@riege.com, Information: http://www.riege.com

This email is intended to be viewed with a nonproportional font.
Public Key on http://www.keyserver.net, Key-ID: 3D4027B5
Fingerprint: 1970 C78D 9A1D 99FA 5CE4  5C0D 29E6 6A95 3D40 27B5


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: tasklist plugin help needed

Posted by Gabriel Sjoberg <xa...@cox.net>.
Maarten Coene wrote:

> /**
>  * The description of my method
>  * @todo Refactor this method
>  */
>  public void myMethod() { ... }
>
> I tried to generate the todo list with "maven tasklist" .
>
> What should I do to get the tasklist plugin generate a todo list?

You may want to verify that the following line exists in one of your 
.properties files:

maven.tasklist.taskTag = <your tag here>

The tag is case-sensitive, so you'll need to verify that your case is 
similar across all files.  I had the same problem you did at first, but 
I realized that my tag was @TODO, so the plugin didn't pick it up.  
Perhaps case-insensitivity can be added to a future version of the plugin.

-GS


---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


RE: tasklist plugin help needed

Posted by Maarten Coene <Ma...@Toughguy.net>.
ok, my project.xml wasn't completely correct (the order of some elements 
are not correct).

But that's fixed now: pom:validate says my project.xml file is correct. 
Unfortunately, the generated todo-list is still empty

Maarten

At 13:29 6/06/2003 +0200, you wrote:
>Just an idea...
>
>Can you run "maven pom:validate" to verify that your project.xml is
>correct. Maybe the <reports> tag needs to be located at the end.
>
>Thanks
>-Vincent
>
> > -----Original Message-----
> > From: Maarten Coene [mailto:MacBelgium@Toughguy.net]
> > Sent: 06 June 2003 13:23
> > To: Maven Users List
> > Subject: Re: tasklist plugin help needed
> >
> > I've included my project.xml and the generated task-list.xml file.
> > I'm also using the latest CVS version of maven.
> >
> > === projext.xml ===
> > <?xml version="1.0"?>
> > <project>
> >    <pomVersion>3</pomVersion>
> >    <name>wisecare</name>
> >    <id>wisecare</id>
> >    <currentVersion>1.0-dev</currentVersion>
> >    <organization>
> >      <name>QMedit</name>
> >      <url>http://www.qmedit.com/</url>
> >    </organization>
> >    <inceptionYear>2003</inceptionYear>
> >    <package>com.qmedit.wisecare</package>
> >
> >    <shortDescription>Wisecare Project</shortDescription>
> >
> >    <description>
> >      This is a description of the Wisecare project.
> >    </description>
> >
> >    <reports>
> >      <report>maven-tasklist-plugin</report>
> >    </reports>
> >
> >    <dependencies>
> >
> >      <dependency>
> >        <id>colt</id>
> >        <version>SNAPSHOT</version>
> >      </dependency>
> >
> >      <dependency>
> >        <id>commons-collections</id>
> >        <version>SNAPSHOT</version>
> >      </dependency>
> >
> >      <dependency>
> >        <id>commons-digester</id>
> >        <version>SNAPSHOT</version>
> >      </dependency>
> >
> >      <dependency>
> >        <id>qmedit-commons-misc</id>
> >        <version>SNAPSHOT</version>
> >      </dependency>
> >
> >
> >    </dependencies>
> >
> >    <build>
> >
> >      <sourceDirectory>src/java</sourceDirectory>
> >
> >    </build>
> > </project>
> >
> >
> > === task-list.xml ===
> > <?xml version="1.0" encoding="ISO-8859-1"?>
> > <document>
> >
> >    <properties>
> >      <author
>email="turbine-maven-user@jakarta.apache.org">Maven</author>
> >      <title>Articles</title>
> >    </properties>
> >
> >    <body>
> >      <section name="Todos">
> >            <p>
> >            </p>
> >            <table>
> >                  <th>Class</th>
> >                  <th>Class Todos Count</th>
> >                  <th>Method with Todos</th>
> >            </table>
> >            <hr/>
> >        <p>
> > </p>
> >      </section>
> >    </body>
> > </document>
> >
> >
> > At 12:24 6/06/2003 +0200, you wrote:
> > >Do you have your source directory specified in your project.xml file.
>In
> > >this file there needs to be a tag like this:
> > >
> > >   <sourceDirectory>src/java</sourceDirectory>
> > >
> > >The tasklist plugin looks into this directory for java files  to
>process.
> > >
> > >Maarten Coene wrote:
> > >
> > >>Yes it's included in my project.xml file.
> > >>
> > >>The tasklist report is generated, but it contains an empty table of
>todo
> > >>items.
> > >>
> > >>Maarten
> > >
> > >
> > >
> > >---------------------------------------------------------------------
> > >To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > >For additional commands, e-mail: users-help@maven.apache.org
> > >
> >
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>For additional commands, e-mail: users-help@maven.apache.org




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


RE: tasklist plugin help needed

Posted by Vincent Massol <vm...@pivolis.com>.
Just an idea...

Can you run "maven pom:validate" to verify that your project.xml is
correct. Maybe the <reports> tag needs to be located at the end.

Thanks
-Vincent

> -----Original Message-----
> From: Maarten Coene [mailto:MacBelgium@Toughguy.net]
> Sent: 06 June 2003 13:23
> To: Maven Users List
> Subject: Re: tasklist plugin help needed
> 
> I've included my project.xml and the generated task-list.xml file.
> I'm also using the latest CVS version of maven.
> 
> === projext.xml ===
> <?xml version="1.0"?>
> <project>
>    <pomVersion>3</pomVersion>
>    <name>wisecare</name>
>    <id>wisecare</id>
>    <currentVersion>1.0-dev</currentVersion>
>    <organization>
>      <name>QMedit</name>
>      <url>http://www.qmedit.com/</url>
>    </organization>
>    <inceptionYear>2003</inceptionYear>
>    <package>com.qmedit.wisecare</package>
> 
>    <shortDescription>Wisecare Project</shortDescription>
> 
>    <description>
>      This is a description of the Wisecare project.
>    </description>
> 
>    <reports>
>      <report>maven-tasklist-plugin</report>
>    </reports>
> 
>    <dependencies>
> 
>      <dependency>
>        <id>colt</id>
>        <version>SNAPSHOT</version>
>      </dependency>
> 
>      <dependency>
>        <id>commons-collections</id>
>        <version>SNAPSHOT</version>
>      </dependency>
> 
>      <dependency>
>        <id>commons-digester</id>
>        <version>SNAPSHOT</version>
>      </dependency>
> 
>      <dependency>
>        <id>qmedit-commons-misc</id>
>        <version>SNAPSHOT</version>
>      </dependency>
> 
> 
>    </dependencies>
> 
>    <build>
> 
>      <sourceDirectory>src/java</sourceDirectory>
> 
>    </build>
> </project>
> 
> 
> === task-list.xml ===
> <?xml version="1.0" encoding="ISO-8859-1"?>
> <document>
> 
>    <properties>
>      <author
email="turbine-maven-user@jakarta.apache.org">Maven</author>
>      <title>Articles</title>
>    </properties>
> 
>    <body>
>      <section name="Todos">
>            <p>
>            </p>
>            <table>
>                  <th>Class</th>
>                  <th>Class Todos Count</th>
>                  <th>Method with Todos</th>
>            </table>
>            <hr/>
>        <p>
> </p>
>      </section>
>    </body>
> </document>
> 
> 
> At 12:24 6/06/2003 +0200, you wrote:
> >Do you have your source directory specified in your project.xml file.
In
> >this file there needs to be a tag like this:
> >
> >   <sourceDirectory>src/java</sourceDirectory>
> >
> >The tasklist plugin looks into this directory for java files  to
process.
> >
> >Maarten Coene wrote:
> >
> >>Yes it's included in my project.xml file.
> >>
> >>The tasklist report is generated, but it contains an empty table of
todo
> >>items.
> >>
> >>Maarten
> >
> >
> >
> >---------------------------------------------------------------------
> >To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> >For additional commands, e-mail: users-help@maven.apache.org
> >
> 
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: tasklist plugin help needed

Posted by Maarten Coene <Ma...@Toughguy.net>.
I've included my project.xml and the generated task-list.xml file.
I'm also using the latest CVS version of maven.

=== projext.xml ===
<?xml version="1.0"?>
<project>
   <pomVersion>3</pomVersion>
   <name>wisecare</name>
   <id>wisecare</id>
   <currentVersion>1.0-dev</currentVersion>
   <organization>
     <name>QMedit</name>
     <url>http://www.qmedit.com/</url>
   </organization>
   <inceptionYear>2003</inceptionYear>
   <package>com.qmedit.wisecare</package>

   <shortDescription>Wisecare Project</shortDescription>

   <description>
     This is a description of the Wisecare project.
   </description>

   <reports>
     <report>maven-tasklist-plugin</report>
   </reports>

   <dependencies>

     <dependency>
       <id>colt</id>
       <version>SNAPSHOT</version>
     </dependency>

     <dependency>
       <id>commons-collections</id>
       <version>SNAPSHOT</version>
     </dependency>

     <dependency>
       <id>commons-digester</id>
       <version>SNAPSHOT</version>
     </dependency>

     <dependency>
       <id>qmedit-commons-misc</id>
       <version>SNAPSHOT</version>
     </dependency>


   </dependencies>

   <build>

     <sourceDirectory>src/java</sourceDirectory>

   </build>
</project>


=== task-list.xml ===
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>

   <properties>
     <author email="turbine-maven-user@jakarta.apache.org">Maven</author>
     <title>Articles</title>
   </properties>

   <body>
     <section name="Todos">
           <p>
           </p>
           <table>
                 <th>Class</th>
                 <th>Class Todos Count</th>
                 <th>Method with Todos</th>
           </table>
           <hr/>
       <p>
</p>
     </section>
   </body>
</document>


At 12:24 6/06/2003 +0200, you wrote:
>Do you have your source directory specified in your project.xml file. In 
>this file there needs to be a tag like this:
>
>   <sourceDirectory>src/java</sourceDirectory>
>
>The tasklist plugin looks into this directory for java files  to process.
>
>Maarten Coene wrote:
>
>>Yes it's included in my project.xml file.
>>
>>The tasklist report is generated, but it contains an empty table of todo 
>>items.
>>
>>Maarten
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>For additional commands, e-mail: users-help@maven.apache.org
>




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


Re: tasklist plugin help needed

Posted by Juergen Heidak <Ju...@Heidak.de>.
Do you have your source directory specified in your project.xml file. In 
this file there needs to be a tag like this:

   <sourceDirectory>src/java</sourceDirectory>

The tasklist plugin looks into this directory for java files  to process.

Maarten Coene wrote:

> Yes it's included in my project.xml file.
>
> The tasklist report is generated, but it contains an empty table of 
> todo items.
>
> Maarten
>



---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


RE: tasklist plugin help needed

Posted by Maarten Coene <Ma...@Toughguy.net>.
Yes it's included in my project.xml file.

The tasklist report is generated, but it contains an empty table of todo items.

Maarten

At 11:41 6/06/2003 +0200, you wrote:
>Hi Maarten,
>
>Have you added the report to your project.xml?
>
>   <reports>
>[...]
>     <report>maven-tasklist-plugin</report>
>   </reports>
>
>-Vincent
>
> > -----Original Message-----
> > From: Maarten Coene [mailto:MacBelgium@Toughguy.net]
> > Sent: 06 June 2003 11:34
> > To: users@maven.apache.org
> > Subject: tasklist plugin help needed
> >
> > Hi,
> >
> > I want to use the tasklist plugin, but the plugin doesn't find any
>todo's
> > in my source code. For my todo's, I use the "@todo" tag in the javadoc
>of
> > my method, e.g.:
> >
> > /**
> >   * The description of my method
> >   * @todo Refactor this method
> >   */
> >   public void myMethod() { ... }
> >
> > I tried to generate the todo list with "maven tasklist" .
> >
> > What should I do to get the tasklist plugin generate a todo list?
> >
> > thx
> > Maarten Coene
> >
> >
> >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> > For additional commands, e-mail: users-help@maven.apache.org
>
>
>
>---------------------------------------------------------------------
>To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
>For additional commands, e-mail: users-help@maven.apache.org




---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org


RE: tasklist plugin help needed

Posted by Vincent Massol <vm...@pivolis.com>.
Hi Maarten,

Have you added the report to your project.xml?

  <reports>
[...]
    <report>maven-tasklist-plugin</report>
  </reports>

-Vincent

> -----Original Message-----
> From: Maarten Coene [mailto:MacBelgium@Toughguy.net]
> Sent: 06 June 2003 11:34
> To: users@maven.apache.org
> Subject: tasklist plugin help needed
> 
> Hi,
> 
> I want to use the tasklist plugin, but the plugin doesn't find any
todo's
> in my source code. For my todo's, I use the "@todo" tag in the javadoc
of
> my method, e.g.:
> 
> /**
>   * The description of my method
>   * @todo Refactor this method
>   */
>   public void myMethod() { ... }
> 
> I tried to generate the todo list with "maven tasklist" .
> 
> What should I do to get the tasklist plugin generate a todo list?
> 
> thx
> Maarten Coene
> 
> 
> 
> 
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
> For additional commands, e-mail: users-help@maven.apache.org



---------------------------------------------------------------------
To unsubscribe, e-mail: users-unsubscribe@maven.apache.org
For additional commands, e-mail: users-help@maven.apache.org