FAQ - stoicflame/enunciate GitHub Wiki
FAQ
Project Setup
- Why isn't the documentation in my JavaDoc comments getting picked up by Enunciate?
- How do I tell Enunciate where my application is deployed so it generates correct documentation?
- How do I tell Enunciate to ignore or exclude classes? How do I tell Enunciate to explicitly include classes?
- Why does the documentation say my result type is "unknown," "custom,", or "object"?
- How do I apply Enunciate to a multi-module project? How do I use classes that were built in a different module/project?
- I've got a WSDL I need to conform to. Does Enunciate support contract-first development?
- How do I use Maven to deploy an Enunciate-generated client-side artifact?
- What's up with the "Java compiler has crashed" error?
- Why do I have two "JSON" sections in my generated documentation?
- How do I tell Enunciate that JSON dates are serialized as strings and not numbers?
- Why won't Enunciate "see" my annotations/JavaDoc on my properties?
- How do I disable Enunciate's noisy warnings?
Customization
- How do I exclude certain aspects of my API from the generated documentation?
- What annotations are available to provide Enunciate additional information about how to document my API?
- How do I apply a custom skin to the generated documenation?
- Is there a directory of custom themes?
- How do I customize my namespace prefixes?
- How do I customize the file names of the generated WSDL and schema files?
Client-Side
Integration
- Does Enunciate Integrate with Lombok?
- What if I'm not using JAX-RS or Spring? Can I still leverage Enunciate's documentation capabilities?
- Can I use Enunciate to generate documentation from non-Java source code?
Enunciate 1.x
(The following questions are only applicable to Enunciate 1.x, and not to Enunciate 2.)
- I just want Enunciate to generate the documentation. I don't want Enunciate to compile and build the project.
- How do I avoid the OutOfMemoryError when compiling GWT?
- How do I disable the Enunciate warnings?
- Why does Enunciate think a list is a custom element?
- How do I apply my own Spring configuration?
- How do I integrate with an existing web app?
- How do I secure my Web services?
- How is the lifecycle of JAX-RS endpoint beans defined?