[OPENMEETINGS-106] JabberService is missing in the API Doclet task that generates the SOAP/REST API Documentation

• Type: Task
• Status: Closed
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 2.0.0 Apache Incubator Release
• Fix Version/s: 2.0.0 Apache Incubator Release
• Component/s: SOAP/REST API
• Assignee: Maxim Solodovnik
• Reporter: Steve R Wagner
• Created: 28/Mar/12 12:48
• Updated: 18/Jul/12 19:55
• Resolved: 30/Mar/12 03:03

Description

the JabberService is missing in the API Doclet task that generates the SOAP/REST API Documentation... well maybe some documentation from my side is also missing how that thing works

How to enable a new webservice in the doc tool:
1) You need to add the class JabberWebService in the Ant targets: build.webservice.doc, build.only.webservice.doc
2) You need to add regular java-doc to each function and to the class itself describing each parameter and a short description of the method/class like in FileWebService for example (you will see a warning info text in the generated docs if the java-doc doesn't match method's parameter count)
3) You need to slightly change the template so that the links to the newly created WebService is visible in the generated docs: In docs/ApiMethodsTemplate.vm you need to change the height of the iFrame from 140 maybe to 180

Btw: There are two velocity templates in the docs folder ApiMethodsTemplate.vm and ApiClassesTemplate.vm that are needed to generate the SOAP/REST API docs. If you are going to remove the generated "docs" folder those velocity template files should be moved somewhere else and the Doclet task has to be changed to the new paths.