Issue Details (XML | Word | Printable)

Key: FOR-820
Type: Bug Bug
Status: Closed Closed
Resolution: Won't Fix
Priority: Minor Minor
Assignee: Unassigned
Reporter: David Crossley
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
Forrest

tools/forrestdoc needs general tidy up and some documentation to encourage its use

Created: 25/Feb/06 08:58 AM   Updated: 12/Sep/07 10:39 PM
Return to search
Component/s: Documentation and website, Other
Affects Version/s: 0.9-dev
Fix Version/s: None

Time Tracking:
Not Specified


 Description  « Hide
tools/forrestdoc needs general tidy up and some documentation to encourage its use.

See collection of some links in
http://marc.theaimsgroup.com/?l=forrest-dev&m=114082527806288


 All   Comments   Work Log   Change History   Subversion Commits      Sort Order: Ascending order - Click to sort in descending order
Gavin added a comment - 15/Mar/06 08:09 PM
But we have to get it working yet, or did I miss that bit?

Around Line 667 of Pass2.java is being pointed to as the culprit, but as ever with programming, the cause could be earlier on, I don't know enough about it to know.

   return ((String) o1).compareTo(o2);

Looks ok, but other files skipped during compilation may be having an effect. Just a guess, if someone can look to get it working, then we can work on this issue of tidy up & doc creation.

Thorsten Scherler added a comment - 05/Jun/07 06:43 AM
We need to review and see which points are gone:
http://marc.info/?l=forrest-dev&m=107633288925954&w=2
Things to do to make it usable:

0 - make a code scanner so that this can be applied to any project
     without effort
1 - interlink javasrc and javadocs
2 - make javadocs from the xml format (skin)
2 - better uml page
3 - use the javadoc skin to make vizant docs
4 - add source views for other formats
6 - major overhaul of jsdoc

After this:

7 - integrate all in a single navigation - database of references
8 - output also to javahelp format
9 - make plugins for different languages


David Crossley added a comment - 11/Sep/07 02:51 AM
Recently Apache Maven have expressed interest in taking over this code. See the following email threads:

Re: Forrestdoc and Maven JXR
http://marc.info/?t=118096009200007

Re: [Proposal] decide the future of forrestdoc
http://marc.info/?t=118413398900001

The latter has a list of steps for finalisation of the handover.

Vincent Siveton added a comment - 12/Sep/07 12:33 PM

Ross Gardler added a comment - 12/Sep/07 10:39 PM
moved forrestdoc code and issues to Maven