Hiyas,
After going for four days now trying to get debugging running on xdoclet CVS
HEAD (please help!!!), it struck me that having a parallel system like the
TODO system -- but focused entirely on undocumented changes -- would be
extremely useful, helpful, and save you guys a lot of time answering stupid
questions from newbie losers like me.
With such a system, one might make a tag of:
* @feature-change: The xyz tag now needs to be configured with ...
The generated output would have a link back to the code where the tag was
generated. The goal is twofold:
1) The change is called out so users don't spend days trying to get
something
working that is otherwise failing silently due to lack of good error
msgs.
The user would know something is up, that they should work really hard
to
understand what's up here, not just throw up their hands in
desperation.
2) The change is linked to the source, which is really the best
documentation
there is anyway. Often, if *you know where to find something* in the
source, it's easy to figure out what to do.
It's true that the source is already there and in theory someone could just
go read it, look at CVS history, etc., but that presumes an understanding of
the source to begin with. Completely learning the source in order to do
*anything* with it is a very onerous obstacle to adoption. And when changes
need to be made to the documentation, these deltas provide all the hints that
are necessary for a documentor to bring them up to date.
It's not going to make a difference tomorrow afternoon, but over time it will
become very useful.
I'd contribute it, but I can't even figure out how to get debugging turned
on, much less get the work done that I need to do with the tool. I will
sometime in the next few months if I can get caught up and it's still waiting
to go in.
Thanks for your time. And if you know how to turn on debugging, please tell
me!! The "-Dlog4j.configuration=file://c:/dev/bill2/log4j.properties" on the
command line doesn't seem to work.
-b
_________________________________________________________
If you have some ice cream, I will give it to you.
If you have no ice cream, I will take it away from you.
- Ice Cream Koan
_______________________________________________________________
Don't miss the 2002 Sprint PCS Application Developer's Conference
August 25-28 in Las Vegas -
http://devcon.sprintpcs.com/adp/index.cfm?source=osdntextlink
_______________________________________________
Xdoclet-devel mailing list
[EMAIL PROTECTED]
https://lists.sourceforge.net/lists/listinfo/xdoclet-devel
