FroMage / jax-doclets

Set of JavaDoc doclets for modern Java annotations APIs
http://www.lunatech-labs.com/open-source/jax-doclets
GNU Lesser General Public License v3.0
26 stars 23 forks source link

@FORM annotated parameter documented as String #38

Open ivayloyotov opened 12 years ago

ivayloyotov commented 12 years ago

We are using jax-doclets to generate documentation from Java code and RESTeasy. Noticed that @Form annotated parameters appear as String in the generated documentation. For example:

@GET ResponseObjectClass someMethod(@Form RequestObjectClass request) { ... }

appears as:

Input: String

Output: ResponseObjectClass

in the generated documentation.

On page http://fromage.github.com/jax-doclets/docs/0.10.0/html/index.html is said: "3.5 Supported RESTEasy JAX-RS extension annotations

If the optional RESTEasy dependency is present, the following RESTEasy annotations are supported on resource methods or classes:

@Form"

and we tried to add this optional RESTeasy dependency in the pom.xml, several times, at different places in the pom.xml - inside the for the JAXRSDoclet and outside of it, but none seems to work.

Can you please give an example how and where the optional RESTeasy dependency should be used in order to generate proper documentation for a @Form annotated parameter object.

Thank you. Regards

FroMage commented 12 years ago

The test in https://github.com/FroMage/jax-doclets/blob/master/doclets/src/test/java/com/lunatech/doclets/jax/test/FormTest.java uses it (see http://fromage.github.com/jax-doclets/examples/jaxrsdocs/form-%7Bid%7D/index.html for output) without issues. Check the pom at https://github.com/FroMage/jax-doclets/blob/master/doclets/pom.xml for comparison