| Summary: | [tycho-document-bundle] add support for custom doclets + docletArtifact | ||||||||
|---|---|---|---|---|---|---|---|---|---|
| Product: | z_Archived | Reporter: | Christian Dietrich <christian.dietrich.opensource> | ||||||
| Component: | Tycho | Assignee: | Martin Schreiber <Martin.SCHREIBER> | ||||||
| Status: | RESOLVED FIXED | QA Contact: | |||||||
| Severity: | enhancement | ||||||||
| Priority: | P3 | CC: | jan.sievers, Martin.SCHREIBER, t-oberlies | ||||||
| Version: | unspecified | Keywords: | helpwanted | ||||||
| Target Milestone: | --- | ||||||||
| Hardware: | All | ||||||||
| OS: | All | ||||||||
| Whiteboard: | |||||||||
| Attachments: |
|
||||||||
|
Description
Christian Dietrich
Do you expect that to be part of the javadocOptions parameter:
<configuration>
<javadocOptions>
<doclet>foo.bar.MyDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>mygroupid</groupId>
<artifactId>myartifactid</artifactid>
<version>1.0</version>
</docletArtifact>
<docletArtifact>
<groupId>myothergroupid</groupId>
<artifactId>myotherartifactid</artifactid>
<version>1.0</version>
</docletArtifact>
</docletArtifacts>
</javadocOptions>
</configuration>
or should that be outside of the javadocOption:
<configuration>
<doclet>foo.bar.MyDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>mygroupid</groupId>
<artifactId>myartifactid</artifactid>
<version>1.0</version>
</docletArtifact>
<docletArtifact>
<groupId>myothergroupid</groupId>
<artifactId>myotherartifactid</artifactid>
<version>1.0</version>
</docletArtifact>
</docletArtifacts>
</configuration>
inside the javadoc options would be fine. I prepared a patch, to verify it before submitting it would be greate to have a working example. Do you have a simple sample project that you can attach here? Created attachment 249334 [details]
Sample Doclet
Sample Doclet
Created attachment 249335 [details]
Sample Usage of Doclet
Sample Usage of Doclet
please find the example attached Submitted a patch for review: https://git.eclipse.org/r/#/c/37956/ Now a custom doclet and doclet artifacts can be specified.
Example configuration:
<configuration>
<javadocOptions>
<ignoreError>false</ignoreError>
<doclet>foo.bar.MyDoclet</doclet>
<docletArtifacts>
<docletArtifact>
<groupId>foo.bar</groupId>
<artifactId>foo.bar.mydocletartifact</artifactId>
<version>1.0</version>
</docletArtifact>
</docletArtifacts>
</javadocOptions>
</configuration>
this actually seems work only if the doclet artifact is selfcontained or if you lit the doclets dependencies manually. IF the doclet has dependencies these wont be find. using the maven javadoc plugin this worked fine. Reopening because the dependencies of the doclet artifacts are not resolved and added to the javadoc class path Now also the transitive dependencies will be resolved and added to the doclet path. works fine now Would someone write something about this feature on the 0.23 release notes page [1]? I suppose that this feature is worth mentioning. [1] https://wiki.eclipse.org/Tycho/Release_Notes/0.23 (In reply to Tobias Oberlies from comment #13) > Would someone write something about this feature on the 0.23 release notes > page [1]? I suppose that this feature is worth mentioning. > > [1] https://wiki.eclipse.org/Tycho/Release_Notes/0.23 I will add notes to the Release Notes. Btw,change submitted with commit: https://git.eclipse.org/c/tycho/org.eclipse.tycho.extras.git/commit/?id=2c126a87d47dc6ed243504c4d50a88008e24d0f3 |