There are a few things in my mind:
1) Configure the maven plugin to produce javadoc for SPIs
2) Use a Javadoc diff tool [1] to generate a report for the SPI changes
3) The SPI packages can be found automatically by parsing the
META-INF/MANIFEST.MF for OSGi Export-Package headers. I have local code to
print out a list of that. We can even extend that to document extension
points.
4) I also build a web application in my sandbox [2] that can list maven
dependencies for a given tuscany binding/implementation/policy extension.
5) Some of the functions can be integrated with our maven-bundle-plugin to
perform post distribution reporting.
[1] http://javadiff.sourceforge.net/
[2]
https://svn.apache.org/repos/asf/tuscany/sandbox/rfeng/tuscany-provisioning
Thanks,
Raymond
--------------------------------------------------
From: "Simon Laws" <[email protected]>
Sent: Wednesday, March 10, 2010 3:11 AM
To: <[email protected]>
Subject: Re: [2.x] SPI documentation, testing and tracking
On Tue, Mar 9, 2010 at 4:01 PM, kelvin goodson <[email protected]>
wrote:
I'd like to help with this. I'd like to get a clear picture of these
interfaces myself, so marking them up would be a great way to do this.
I don't have a good feel for how to split these into sets, but I'm
happy to take input. I would naturally favour annotations or
javadoc, but I'll probably do something quicker, outside of the code,
in the short term to get a straw man to be picked at before thinking
about editing the code.
Kelvin.
Very happy to have some help Kelvin. What did you have in mind in
terms of "something quicker, outside of the code,"?
Simon
