Comments (7)
I think it's a source issue, javadoc needs to have access to the source of the first module for this to work.
from jax-doclets.
I'm getting successful generation of docs from interfaces.
Note: my interfaces sources are accessible to maven at build time.
from jax-doclets.
I'm using the same configuration - interface module A (containing the JAX-RS annotated interfaces and types) and implementation module B (depending on A), and I'm having the same problem. I would appreciate specific configuration example solving the issue. I'm getting empty documentation generated when configured on the interface module A, also.
from jax-doclets.
Issue #2 "Generate documentation based on interface (without any implementation)" seems related.
from jax-doclets.
There's not much to my config. I have multiple interfaces that are annotated with annotations from javax.ws.rs. Absolutely no JAX-RS annotations exist down in my implementations.
Other than that, my code is a standard maven2 project.
Here's my pom.xml reporting snippet:
<reporting>
<plugins>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>cobertura-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.7</version>
<reportSets>
<reportSet>
<configuration>
<name>REST Doclets</name>
<description>JAXRS-based auto-generated RESTful Doclets</description>
<header>
<![CDATA[My custom HTML header]]>
</header>
<footer>
<![CDATA[My custom HTML footer]]>
</footer>
<stylesheetfile>${basedir}/src/site/css/custom.css</stylesheetfile>
<doclet>com.lunatech.doclets.jax.jaxrs.JAXRSDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>com.lunatech.jax-doclets</groupId>
<artifactId>doclets</artifactId>
<version>0.9.0</version>
</docletArtifact>
</docletArtifacts>
<destDir>jaxrsdocs</destDir>
</configuration>
<reports>
<report>javadoc</report>
</reports>
</reportSet>
</reportSets>
</plugin>
</plugins>
</reporting>
from jax-doclets.
The above configuration may work if you have both the interfaces and implementation classes in the same module (I didn't actually got what's your configuration regarding "my interfaces sources are accessible to maven at build time").
So, the doclet doesn't basically work when configured on the interface module A, because of issue #2. It works when configured on the implementation module B which declares dependency on module A and the javadoc plugin configuration have to include:
<configuration> ... <includeDependencySources>true</includeDependencySources> ... </configuration>
Module A have to be configured to install sources artifact, also:
<plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-source-plugin</artifactId> <version>2.1.2</version> <executions> <execution> <id>attach-sources</id> <phase>verify</phase> <goals> <goal>jar-no-fork</goal> </goals> </execution> </executions> </plugin>
from jax-doclets.
Guys, sorry I won't have time to look into this issue before a while, but if you manage to find and fix the issue I'll merge your pull request.
from jax-doclets.
Related Issues (20)
- FileNotFoundException: /doclet.css (Permission denied) HOT 1
- attributes rendered in json with leading @ HOT 2
- Need way to disable top menu items HOT 1
- java.util.Collection not recognized as collection HOT 3
- @XmlAccessorType in package-info ignored HOT 3
- Parser/ docs do not recurse into @Form tags HOT 6
- Ability to use doclet for project without any related javadocs. HOT 12
- Support for @ApplicationPath in JAX-RS doclet HOT 1
- Cosmetic: Invalid @Override tags in source code
- @returnWrapped javadoc tag leads to NPE
- NoSuchElementException in JAX-RS doclet HOT 1
- Does not include description on the top of service HOT 1
- Add doclet for JAX-WS HOT 4
- java.lang.RuntimeException: java.io.FileNotFoundException HOT 1
- Ignore one or many method parameters from a JAXRS resources
- Java 8 compatibility HOT 22
- Release 0.10.1 HOT 4
- example for how to generate jax-rs doc with jaxb links HOT 4
- NoSuchMethodError: com.sun.tools.doclets.formats.html.HtmlDocletWriter HOT 1
- Support for @RequiredRequestHeader or similar HOT 1
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from jax-doclets.