If I was a plugin writing kind of person I would write two plugins ( or doclet).
1. A documentation plug in that would have a stronger narrative element ( that is a starting point). this would complement the kind of documentation you get a moment but add to it.
1. Starting point
@purpose ?
2. tutorial ( hyperlinked code examples)
3. examples ( more code + hyper links )
At the moment I love java doc but the resultant documentation is usless for getting started.
The second plug in would be part of the bug tracking system.
@bug ID [ message ]
would attached a bug from the bug tracking system via document hyperlink. when a bug is fixed then it can
be part of documentation/code base
@TODO anyone ?
Subscribe to:
Post Comments (Atom)
No comments:
Post a Comment