stoicflame/enunciate — pull request #21 by renatobertacco (2013-07-05 09:39:24+00:00)
Title: Support to differentiate web-service and java method documentation

In some cases java classes can be both java DAO and web services. Of course both use cases need documentation. In my case, using @Context annotation I use a Map to store all query parameters sent from a REST call and I need to document the Map parameter for java calls by javadoc and http query parameters for REST requests by enunciate. In enunciate documentation I don't have found anything for this use case. What I see is that enunciate matches queryParams inserted in @ResourceMethodSignature with @param annotation in javadoc. What I suggest is to allow overriding the default behavior supporting also @RSParam annotation. For example:
/**
* some documentation
* @param map a MultivaluedMap
* @RSParam queryParam a query param
*
* @return a Bean
**/
@GET
@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML})
@ResourceMethodSignature(queryParams={@QueryParam("queryParam")})
public Bean getBean(@Context MultivaluedMap map){
....
}

With my proposal enunciate matches the queryParam with @RSParam annotation for producing the REST documentation.