Hi,
I spent the day poking through Avalon source, and created a couple of
patches (attached). Except for the first, they're mostly doc fixes and
not very exciting. None of them break API backwards-compatibility.
linklocaldocs.diff
------------------
When the xdocs are generated, the links to Javadocs and other subproject
docs are all "http://jakarta.apache.org/avalon/..";. I suppose that's
safe, because not everyone has generated local javadocs, or downloaded
the other subprojects, but it would be nice to at least let the user
link to local docs (particularly javadocs).
This patch solves the problem (without upsetting the status quo) by
allowing the user to set Ant variables to specify where external docs
are located. Usually, this would be done in a .ant.properties, so I've
included a "ant.properties.sample" with commented-out examples.
cli_docfixes.diff
-----------------
This patch is mostly fixing typos/spelling and improving javadocs.
Where a mistake is in a non-private method, I fixed the method name and
made a deprecated wrapper with the old name, to ensure
backwards-compatibility.
I also created a self-contained example of how to use the package, in
package.html. The example is based on Cocoon 2's usage.
The main functional improvement is the declaration of
CLOption.UNKNOWN_OPT, which makes use of the API clearer (as
demonstrated in the example). This is backwards-compatible as long as
UNKNOWN_OPT=0, as in the patch.
docfixes.diff
-------------
This fixes all grammar errors and typos in src/xdocs that I could find.
Yes, there were lots ;P
other.diff
----------
Misc other typo/spelling fixes scattered across Avalon, none affecting
the API.
--Jeff
linklocaldocs.diff.gz
docfixes.diff.gz
other.diff.gz
cli_docfixes.diff.gz
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
