[Webtest] [dev] start using xdoclet to extract doc

Marc Guillemot webtest@lists.canoo.com
Mon, 08 Nov 2004 14:39:51 +0100


Hi,

as discussed earlier, I've added the "base structure" to start using xdoclet to generate documentation. The ant target 
"extractDoc" currently just extract documentation from the java files and generate an xml file. The generated xml file 
is not yet transformed by an xslt to generate documentation. We now have to look if/how we want to integrate it.

As an example I've only added tags in the class com.canoo.webtest.extension.SetFileField. This looks as follows:


In the javadoc of the class:

  * @webtest.step
  * 	name="setfilefield"
  * 	description="Permits to set an <input type=\"file\" ...> form field."

In the javadoc of the getFileName() method:

  * @webtest.parameter
  * 	required="true"
  *  description="The name of the file to upload."

In the javadoc of the getName() method:

  * @webtest.parameter
  * 	required="true"
  *  description="The name of the form field to set."


and that's all. The rest is automagically done by xdoclet thanks a custom template.


Marc.

PS: I'm not an xdoclet expert, just a "simple" user and any advice is welcome.