Win a copy of Escape Velocity: Better Metrics for Agile Teams this week in the Agile and Other Processes forum!
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Liutauras Vilda
  • Tim Cooke
  • Paul Clapham
  • Jeanne Boyarsky
Sheriffs:
  • Ron McLeod
  • Frank Carver
  • Junilu Lacar
Saloon Keepers:
  • Stephan van Hulst
  • Tim Moores
  • Tim Holloway
  • Al Hobbs
  • Carey Brown
Bartenders:
  • Piet Souris
  • Frits Walraven
  • fred rosenberger

A handy XDoclet trick

 
author
Posts: 422
13
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
A very handy, but often overlooked feature of XDoclet is the ability to generate to-do lists. Using the following XDoclet recipe, you can have to-do documentation generated for your project.
First, as with any XDoclet task, you'll need to add the call to XDoclet to your Ant's build.xml (or Maven's maven.xml) file. This Ant target and associated properties are all you need:

Feel free to tweak the Ant properties above to suit your project's directory structure.
Next all you need to do is tag your Java classes and their members with the @todo tag whenever you want to document a to-do reminder. For example:

Now, whenever the "todo" target is invoked in your build, to-do documentation is produced. This documentation is in the form of HTML and closely resembles the structure of JavaDoc.
[ December 11, 2003: Message edited by: Craig Walls ]
[ December 11, 2003: Message edited by: Craig Walls ]
 
Ranch Hand
Posts: 178
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks Craig .
 
Ranch Hand
Posts: 341
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Cool!
 
Looky! I'm being abducted by space aliens! Me and this tiny ad!
Garden Master Course kickstarter
https://coderanch.com/t/754577/Garden-Master-kickstarter
reply
    Bookmark Topic Watch Topic
  • New Topic