Ashish wrote: >>> On Mon, Apr 13, 2009 at 10:55, Ashish <[email protected]> wrote: >>>> One thing that can be done meanwhile is upload the XMPP compliance >>>> report on wiki. >>>> >>>> I did saw the compliance package, and its really great way of >>>> capturing Spec compliance. >>>> We can do something similar for FtpServer and SSHD (typically for >>>> project where we need RFC compliance). >>> You mean some kind of TCK ? where would it come from ? > >> The spec compliance package is a set of annotations to mark classes on >> which part of a RFC the implement and to which degree. Here's an >> example from Vysper: >> @SpecCompliant(spec = "RFC3920", section = "A", status = >> ComplianceStatus.IN_PROGRESS) >> >> >> Using that, Bernd has created a script that produces an HTML report >> that details the compliance level of an implementation. I find it's >> pretty useful and would like to investigate it for FtpServer (if we >> can break it out of Vysper into a standalone JAR and it's optional at >> runtime). > > As of now this info is embedded within javadoc. We are working towards > moving the reports out of > javadoc, into a pdf or something.
The spec compliancy is documented using annotations. Currently, (and I'd propose not to change this) these annotations are retained in javadoc. There is an AnnotationFactory implementation in the code which generates the HTML using the apt tool. This factory is written in a hurry and can easily be improved ;-) The HTML links to javadoc and the specs. I propose to keep rendering to this HTML file. I find it very helpful. Additionally we can rework the AnnotationFactory or create other ones for other purposes. We could create XML instead of directly creating HTML and create PDF and HTML etc via transformation. Bernd
