search

versly / wsdoc

Documentation generator for Spring MVC REST services
Apache License 2.0
62 stars 33 forks source link

Include DTO attribute descriptions #18

Open beerth opened 10 years ago

beerth commented 10 years ago

I'm not sure if this is the right place to ask. I have two questions. 1) Is there a possibility to include the JavaDoc of DTO attributes? 2) Is there a way to document whether DTO attributes are required or optional?

Thank you very much.

pcl commented 10 years ago

The JavaDoc of the attributes should be picked up (from the getters, IIRC). However, the sources for the DTO types do need to be in the classpath when the tool is run to pick them up.

There isn't a concept of required vs. optional currently.

On Wed, Nov 27, 2013 at 5:25 AM, beerth notifications@github.com wrote:

I'm not sure if this is the right place to ask. I have two questions. 1) Is there a possibility to include the JavaDoc of DTO attributes? 2) Is there a way to document whether DTO attributes are required or optional?

Thank you very much.

— Reply to this email directly or view it on GitHubhttps://github.com/versly/wsdoc/issues/18 .

Patrick Linskey 202 669 5907