Stack Overflow
Stack Overflow

Questions tagged [doclet]

Doclet programs work with the Javadoc tool to generate documentation from code written in Java.

Doclet programs work with the Javadoc tool to generate documentation from code written in Java.

source Wikipedia.

83 questions
26
votes
2 answers

Gradle exclude R.java in Android Javadocs when internal classes depend on R.java

I am building JavaDoc for an API wherein classes in the API depend on R.java. I want to build the Javadoc w/o symbol errors referencing the missing R.java file as even when I set failOnError false the build succeeds but our Jenkins job will report…
jdONeill
  • 443
  • 5
  • 10
19
votes
3 answers

How can I debug a Doclet in Eclipse?

I am creating a custom doclet that I want to run in my Maven build with the Javadoc plugin, but right now I'd like to test / debug the Doclet in Eclipse. How can I do that? Do I have to invoke javadoc programmatically? And how?
Sean Patrick Floyd
  • 274,607
  • 58
  • 445
  • 566
8
votes
1 answer

Making a bitbucket source wiki from javadocs

Hi i am working on pretty big internal SDK that we use for our apps. I have outfitted with extensive Javadocs. Now my goal is to somehow generate .MD files from these javadocs so that i can directly put these .md files into my bitbucket wiki. Is…
sn0ep
  • 3,601
  • 8
  • 33
  • 59
8
votes
2 answers

Is there a way to produce Javadoc for a subset of public methods? For example by annotating public methods as "not part of the public API"

I know how to produce Javadoc for a subset of classes/interfaces/packages. But is there a way to produce Javadoc for only a subset of public methods? What I would prefer is to be able to mark methods (Javadoc tag or annotation) as belonging to a…
Frans Lundberg
  • 388
  • 2
  • 8
8
votes
1 answer

How to generate JavaDoc with bootstrap theme?

I want to generate api doc with Bootstrap theme but how to achieve this?
PhilippeVienne
  • 550
  • 8
  • 19
7
votes
1 answer

How to extend JavaDoc 5.0 standard doclet?

I want to extend the standard doclet provided by Javadoc5.0 to modify its HTML output. For example I want to replace the keyword 'implemented' or 'Interfaces' with another word whenever it occurs within the generated JavaDoc HTML. All other elements…
Marfly
  • 71
  • 2
6
votes
0 answers

Eclipse doclet plugin

I'm looking for an Eclipse javadoc doclet plugin that modifies the standard built in javadoc generation process. In other words, I would like to specify custom tags and maybe use wiki syntax or whatever in a normal javadoc comment and have the…
Philip Kamenarsky
  • 2,545
  • 2
  • 19
  • 29
6
votes
1 answer

JavaDoc Parser for common javadocs?

Is there something I can use to parse JavaDoc, such that I can operate on it through the standard Doclet interfaces at runtime? Essentially, the reverse operation of a Doclet. I understand that it would be impossible to write a parser for every…
Bernardo Cunha
  • 333
  • 1
  • 3
  • 10
5
votes
0 answers

What are some cool Javadoc doclet/templates?

I really don't like the way the default Javadocs look. I like the look of this one better. What are some other templates/doclets I can use for generating better JavaDoc pages?
pathikrit
  • 29,060
  • 33
  • 127
  • 206
5
votes
1 answer

Trouble with generating custom javadoc; 'cannot find doclet'

I'm having a go at creating a custom Javadoc generator using Doclet, but I'm running into some issues. I'm following the official documentation and initially had trouble with including the tools.jar file in my project, but I managed to fix this. My…
Farbod Salamat-Zadeh
  • 18,039
  • 16
  • 66
  • 118
5
votes
1 answer

maven-javadoc-plugin overwrites central repository

I have a problem with the Maven Javadoc Plugin and a custom doclet. I'm using the maven-javadoc-plugin v2.10.1 and a custom doclet which is basicly a maven jar project. I have also a settings.xml which defines the central repository to a custom…
Maxx
  • 81
  • 1
  • 9
5
votes
1 answer

Add jar to doclet classpath using maven-javadoc-plugin

I wrote a doclet that collects some data and passes it to a reporter. I want this reporter to be exchangeable. I tried to add a reporter implementation to the doclet classpath using an additionalDependency and/or a pluginDependency. I can't load the…
Sven Tschui
  • 1,109
  • 6
  • 17
5
votes
1 answer

problems to handle some 5.0 language features -- enums and annotations -- in a custom doclet

I am writing a brand new custom doclet using JDK 1.7. These are the problems I have found so far: Doc methods isAnnotationType(), isAnnotationTypeElement(), isEnum() and isEnumConstant() do not work. They always return false. PackageDoc method…
Jorge Campins
  • 341
  • 3
  • 10
5
votes
1 answer

Error generating android project javadoc using Doclava

I'm trying to generate the documentation of my android project using javadoc & doclava. I downloaded the doclava jar and I'm trying to generate the doc through Project-> generate javadoc. If I understood the mechanism, I have two ways to tell…
The Good Giant
  • 1,560
  • 1
  • 18
  • 31
4
votes
0 answers

How to combine multiple javadoc doclets?

I have been working on producing a javadoc for a large project and am not sure what I am trying to do is even possible, or would require making a third doclet combining others. I have been able to successfully use the doclets…
Jacob Block
  • 415
  • 5
  • 15
1
2 3 4 5 6