tasklist.txt

CodeFeedback Tasks
==================

+ build.xml : common driver script
    - basic properties
    - subant loop
    
+ reports-common.xml : common properties and elements for reports
    - path refs
    - tasks
    
+ basic webapp elements
    - web.xml
    - report-style.css (use only one copy, at root of webapp)

+ template report script
    - build.xml
    - description property
    - report.properties

+ reports (basic)
    - cpd               : analysis
    - java2html         : docs
    - javadoc           : docs
    - javancss          : metrics
    - jdepend           : analysis, metrics
    - pmd               : analysis

- reports (extra)
    - beandoc           : doc
    - checkstyle        : analysis
    - cobertura         : analysis
    - cvsdiff           : docs
    - cvschangelog      : docs
    - doccheck          : analysis
    - emma              : analysis
    - findbugs          : analysis
    - hackystat         : analysis
    - hammerapi         : analysis (like PMD)
    - hbm2doc           : docs
    - ivy:report        : docs
    - jaranalyzer       : analysis
    - jester            : analysis
    - jsdoctoolkit      : docs
    - junitreport       : docs
    - junitpdfreport    : docs
    - linguinemaps      : docs (hbm, ant, dtd)
    - macker            : analysis (design rules)
    - qalab             : analysis (trending data)
    - relief            : ??
    - reposita          : metrics (http://meaxure.reposita.org/)
    - schemaspy         : docs
    - sequence          : docs
    - sitegraph         : docs (Struts 2.0)
    - sorcerer (Java 6) : docs (https://sorcerer.dev.java.net/)
    - statcvs           : docs
    - statsvn           : docs
    - svndiff           : docs
    - svnstats          : docs
    - taglibrarydoc     : docs
    - umlgraph          : docs
    - xref (Maven)      : docs
    - xradar            : analysis
    - http://www.lumrix.de/xsbrowser.php
    - http://xframe.sourceforge.net/xsddoc/index.html : no longer active development
    - DocFlex/XML (Kit) : http://www.filigris.com/products/docflex_xml/xsddoc/about.php
    - (function points?)
    
- report categories
    - documentation
    - metrics
    - analysis
    
- docs
    - installation
    - screenshots
    - running from command line
        - from within target project?
        - from within CodeFeedback project?
    - running from CC
    - modifying
        - overriding properties
        - specifying specific reports
        - disabling reports
        - see StatSVN Ant task doc for example of explaining Ant-style glob properties
    - creating new reports
    - FAQ
    - version history?
    - example projects
        - apache-ant
        - cruisecontrol
        - spring-framework (could show use of XSD documentation)
        - Java Petstore (multiple modules)
        - Struts Sampleapp (simple, well known)
        - Geronimo DayTrader ("real" application)
        - JDOM, XOM, commons-lang, etc (components)
        - types: component JAR, webapp, EJB app, Swing app
    - road map/future features
        - summary metrics
        - aggregation of reports for groups of related source projects
        - output that can be aggregated into other project sites
        - separating "doc" output from "metrics" and "analysis" output
            - what needs action and what is description?
        - using groovy for more control
    - building docs from templates
        - http://www.thexmlsite.com/
        - http://www.sagehill.net/docbookxsl/GenerateWebpages.html
        - http://jakarta.apache.org/velocity/docs/anakia.html
        - http://freemarker.sourceforge.net/
        - http://xsite.codehaus.org/

- hosting environment
    - mailing lists
    - source repository
    - issue tracker
    - options:
        http://code.google.com/hosting/
        http://sourceforge.net/
        http://www.ibiblio.org/fosphost (Evaluation of hosting sites)
        http://jbrugge.com
        http://java.net (Sun)
        http://javaforge.com (Javalobby/JRoller folks)
        http://codeplex.com (Microsoft)
        http://berlios.de
        http://freepository.com (only lite version is free)
        
- licensing
    http://www.opensource.org/licenses/index.php
    http://www.nedbatchelder.com/blog/200510.html#e20051016T092523
    http://zooko.com/license_quick_ref.html
    
- extras
    - CC config
    - add "<fail unless...>" to scripts for informative failures
    - add timer to reports
    - wrapper for consolidating output from multiple projects
    - handle reports with multiple modes of output (Emma, UMLGraph, JDepend)
    - see AntAnt by Bill Dehora for other ideas
    
- stylesheets
    - home page
    - CPD
    - FindBugs
    
- project name?
    - CodeFeedback
    - CodeReports
    - FeedbackCentral (no, shorthand would be "FeCe")
    - FeedbackCollector (no, shorthand would be "FeColl")
    - DMA (Doc, Metrics, Analysis)
    - Sherpa : following along behind, doing the unglamorous but important work
      of heavy hauling
    - Grunt
    - Sassytalk
    - backtalk
    - CodePrism
    - ToolCat
    - ProjectSpy
    - Feedback Genie
    - Feedback Garden
    - acumen/apercu/astute/enrich/enlighten/understanding
    - Feedback in a Box
->  - Glean
    - Code Shaman
    - Zahorin
    - Goto
    - Insight Collector
    
- comparison to other tools
    - Doxygen
    - Maven
    - Hackystat
    - XRadar
    - QALabs
    
- defects
    - Javadoc fails if you pass in a package of '' (see CruiseControl source).