2,987 questions
-1
votes
0
answers
67
views
Is it possible to link/run Gradle tasks in comments in IntelliJ Idea? [closed]
I am using IntelliJ Idea with Gradle. Take for example:
/**
* Make sure to run the runData configuration before starting the client
*/
could runData there be substituted for something clickable/...
- 114
Best practices
2
votes
3
replies
64
views
Usage notes in javadocs
If I want to document how my class should be used, should I put it in the javadoc's body or its @apiNote? If it's the former, then what is the latter for?
My impression is the body must be super-...
- 2,667
1
vote
2
answers
103
views
javadoc -locale is invalid on version 17 and 25？
Locale setting is invalid on javadoc 17 and 25:
javadoc -locale en_US -sourcepath .\src\main\java -subpackages my.packages -Xdoclint:none
It always output with my native lanuage rather than english. ...
- 2,181
3
votes
1
answer
153
views
Java 25 Javadoc not allowing Markdown URL link syntax in `@see`
Using Java 25 with the new JEP 467: Markdown Documentation Comments, I tried to add the following:
/// @see [Example Site](https://example.com/)
Javadoc (invoked by Maven) complained "error: ...
- 22.2k
0
votes
1
answer
48
views
IntelliJ: Render JavaDoc for whole class
In IntelliJ, it's possible to render JavaDoc comments via CTRL + ALT + Q into something more readable:
I only see the possibility to do this for a certain method only though. Is there a possibility ...
- 486
0
votes
1
answer
64
views
How do I create a Javadoc link to a class in a sibling module?
Given that:
markdown javadoc comments can link to references
references are defined like this, specifically:
The most general form of a reference is:
module/package.class#member
This project ...
1
vote
1
answer
85
views
is it safe to use a mode-switch rule that matches nothing?
I’m working on a custom Javadoc lexer in ANTLR 4, and I’m trying to handle special mode switching when I reach the start of a line.
I have a simplified example like this:
mode START_OF_LINE;
...
0
votes
0
answers
63
views
Eclipse Javadoc generation for Java records still incomplete?
It seems Eclipse still doesn't generate full Javadoc templates for records — or am I missing something?
I'm using Eclipse 2025-06 with Java 21.
When I type /** above a record, Eclipse only completes ...
- 807
-1
votes
1
answer
40
views
configure freefair aggregate javadoc to ignore javadoc errors
I just updated my freefair plugin from version 8.13.1 to 8.14, and now the javadoc aggregate task fails because of errors in the javadoc.
That's surely a good idea, but I'd really like to decide on my ...
3
votes
1
answer
98
views
How to include the SPI "uses" and/or "provides" section for a module with Javadoc?
If you look at a module's documentation from the standard library, such as java.base, you'll see it has a section that lists which services it uses and which services it provides.
Based on the ...
- 49.9k
2
votes
1
answer
133
views
In eclipse code completion is immediately hidden by yellow javadoc popup
In Eclipse Java Editor when I activate Code completion (either with Ctrl-Space or auto activation on hover) the proposals pop up but nearly immediately another yellow popup shows up with javadoc. It ...
- 21
0
votes
0
answers
21
views
Cannot refer to type parameter in Groovy class Javadoc comment?
I have the following Javadoc comments and class:
/**
* Base class for immutable {@link Iterator} wrappers that provide a view
* into the wrapped {@link Iterator} with its values transformed.
* ...
- 308
0
votes
1
answer
396
views
How to fix "module not found: kotlin.stdlib" or missing dependencies when generating Javadoc in Android Studio?
I'm working on an Android project (Java) and I want to generate Javadoc for my classes using the "Generate Javadoc..." option in Android Studio.
I checked the "Include JDK and library ...
2
votes
0
answers
70
views
Trying to Generate JavaDocs document for JavaFX code
I go to project > Generate JavaDoc > public > finish.
I get this error:
Loading source file
C:\Users\Ethb2\eclipse-workspace\POSSystemV1\src\module-info.java:2: error: module not found: ...
2
votes
0
answers
49
views
Eclipse indenting of nested HTML tags in Javadoc comments
Suppose I have Javadoc comment with:
/**
* <ul>
* <li>stuff</li>
* <li>stuff</li>
* </ul>
*/
When I run any of the eclipse formatting methods on ...
- 5,277
0
votes
0
answers
25
views
maven-javadoc-plugin, java 9 modules and 'impl'
In all my projects I configure the maven-javadoc-plugin with <excludePackageNames> so that impl packages are excluded from the documentation production. But in certain cases I change this ...
- 542
0
votes
0
answers
35
views
In Gradle kts, how to download source and javadoc through a gradle command?
I need to download javadoc & source from the following location:
https://repo1.maven.org/maven2/org/json4s/json4s-jackson_2.13/4.0.7/
How to do it in gradle, or any of its plugin? The following ...
- 3,822
0
votes
1
answer
48
views
Change language of generated JavaDoc in Eclipse
My Eclipse 2024-12 runs on a macOS with the default locale of de_CH, but for a project, I need to generate the JavaDoc in english. The Eclipse export has the following settings:
but the generated ...
- 173
0
votes
0
answers
125
views
IntelliJ reporting "cannot resolve symbol" for a javadoc @link to a symbol in a different module not imported
IntelliJ is showing an @link in red and reporting "Cannot resolve symbol" - the link reference is valid: the fully qualified package.class#method(args) exists - but it is in a module not ...
- 6,098
0
votes
1
answer
71
views
Possible for Spring Boot to serve javadocs without unzipping javadoc.jar manually?
I have a working spring boot app executing from a jar that exposes a REST API, which is documented with springdoc/openapi/swagger by exposing on my spring boot app, too.
I can create the javadoc jar ...
- 113
1
vote
0
answers
31
views
How to embed a star-slash */ inside a @code tag?
I want to embed */* inside a {@code} tag but when I do, the Javadoc tool complains:
error: illegal start of type
{@code */*}.
^
This workaround seems to work: {@code *}{@code /*}
but I'm ...
- 90.9k
2
votes
0
answers
154
views
Google Billing 7.1.0 documentation is not available on Android Studio
I cant get the documentation for Billing-ktx on Android Studio, I've checked the documentation file and its the same that is available on the official link https://maven.google.com/web/index.html?q=...
-1
votes
1
answer
66
views
Is it possible in java, above the usual method, to add javaDoc @see, which will reference the JUnit test
There is a Cube class.
His absolute path: D:/My_projects/my_project/src/main/java/com/Cube.java
There is a method there:
public double get_volume() { ... }
There is a JUnit Test to check the code - ...
- 1
3
votes
0
answers
131
views
Generate Javadoc from Android Studio or gradlew
I realize there are quite a few questions on here already about this, but they all appear to be outdated past the point of being helpful. The two most upvoted are here:
Using gradlew
Using Android ...
- 1,407
0
votes
1
answer
73
views
Maven JavaDoc Plugin doesn't respect language preference
I've set up Maven JavaDoc Plugin to convert my JavaDoc comments into a static HTML site. However, the site generated is in German even though I've set the language preference to English. Note that my ...
- 440
0
votes
0
answers
69
views
Excluding a particular java file from Javadoc aggregate
I am running the following command: mvn install javadoc:javadoc javadoc:aggregate
on a multi sub-module maven project. I need to skip two java files from aggregation phase.
Environment is java 17 and ...
0
votes
0
answers
75
views
Exclude a particular java file from Javadoc aggregation
I am running the following command:
mvn install javadoc:javadoc javadoc:aggregate
on a multi sub-module maven project.
I need to skip a particular java file from aggregation phase but i can't modify ...
1
vote
1
answer
105
views
What should I do if IntelliJ IDEA doesn't display images in javadoc?
I introduced the library "project reactor" in my application. Also, I downloaded the source code and Javadoc, but when I looked at its documentation, the image could not be displayed.
What ...
- 11
0
votes
0
answers
59
views
What is the syntax of JavaDocs comments & how can I generate the documentation page?
I know that javadoc comments use /** Comment */ instead of /* Comment */, and they has special tags like /** @param */. I know that javadoc comments are typically for users, while normal comments are ...
- 45
1
vote
1
answer
263
views
Eclipse Ant Javadoc - warning of no comment on private field
Running the Ant Javadoc process in Eclipse (2022-09 (4.25.0)) with <javadoc access="public"
Getting a handful of these warnings on private fields. However, there are many private ...
- 31
3
votes
1
answer
90
views
Fully-qualified class name of links while parsing Javadoc
In a Java annotation processor, I use DocTrees#getDocCommentTree(Element) to obtain a DocCommentTree, which I walk over with a visitor. Visitor's visitLink(LinkTree,C) method is invoked for found {@...
- 1,928
1
vote
1
answer
961
views
Unable to generate Android Javadoc documentation in Latest Android Studio Giraffe
I have tried every single solution available on the internet trying to generate Javadoc in the latest versions of Android Studio, everytime I get the same "package does not exist", import ...
- 234
-4
votes
2
answers
217
views
What does `@SuppressWarnings("javadoc")` do? When is it Redundant?
I have @SuppressWarnings("javadoc") on almost every class. My IDE gives me a warning on virtually all of them: "Redundant suppression".
I assume advances in technology have made ...
- 4,831
1
vote
1
answer
107
views
javadoc of `java.time.DayOfWeek#minus(long)`
The document writes:
The calculation rolls around the start of the year from Monday to Sunday.
Why does it use "year"?
I also found in plus() it's
The calculation rolls around the end of ...
2
votes
2
answers
254
views
Maven Constructing Javadoc information cannot find symbol from Kotlin
I can successfully compile my maven project using both Kotlin and Java. However javadoc is giving an error because it cannot find a symbol (corresponding to a Kotlin interface) being used in other ...
- 9,503
0
votes
0
answers
40
views
Inheriting @see documentation from the method being overridden?
Given:
interface A
{
/**
* @see some other method
*/
void isGreaterThan(int exclusiveMinimum);
}
interface B extends A
{
/**
* @see {@inheritDoc}
* @throws IllegalArgumentException ...
- 90.9k
1
vote
1
answer
192
views
Why when opening index.html javadoc file generated in Eclipse results in opening in one of the class html file?
I am just starting learning javadoc, and after generating javadoc files, index.html doesn't work as it supposed to, and it happens to all of my java project. Is it because of the Eclipse settings? I ...
- 11
1
vote
1
answer
54
views
Javadoc omits methods in method summary
I have the following interface.
interface Some {
default <T extends Appendable> T append(final T appendable) {
}
default <T extends File> T append(final T file) { // Omitted ...
- 22.4k
0
votes
1
answer
140
views
Anyone can help me to fix this javadoc with maven plugin?
I found out that Maven can generate javadoc for me, and i put this plugin where i got from the internet
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>...
0
votes
1
answer
533
views
maven-javadoc-plugin does not generate javadocs
I have a project with the following structure:
parent
|-api
|-plugin (depends on api)
The project is build using the clean install package tasks from maven on the parent module. The JARs generate ...
- 3
1
vote
1
answer
71
views
How can JavaDocs be configured to be generated in a specified project root directory?
I want to generate my JavaDocs into a given directory in my project root, I know that the destinationDir property exists, but how do I use it also given that my build.gradle exists within a directory ...
- 69
1
vote
1
answer
70
views
How to include generated sources with Gradle's javadoc task?
In my Gradle project, sources are generated into
build/
generated/
annotationProcesor/
java/
main/
test/
And it's just works with command line ...
- 22.4k
4
votes
0
answers
2k
views
Use of default constructor, which does not provide a comment
I am trying to run a maven javadoc command on SpringB oot @Configuration classes without warnings.
Currently, I have a very straightforward Spring Boot configuration class as follows:
/**
* This is ...
- 5,418
1
vote
0
answers
66
views
JavaDoc error: Use of standard constructor that does not provide a comment
When I run the Javadoc code (provided by my university) it shows: Use of standard constructor that does not provide a comment.
I don't really know what I should do/change, so that the error goes away.
...
- 11
-1
votes
1
answer
661
views
Is there an "example use" or "example" Javadoc tag? [closed]
Is there a tag (or a conventional custom tag) for the Javadoc tool that can be used to explain an illustrative use case of a given method?
Example:
/**
* Returns the sum of all the elements in an ...
- 23
0
votes
1
answer
718
views
warning: no @param for field in java 21 with javadoc
I am trying to generate javadoc for very simple java 21 records.
I have this straightforward record:
/**
* The type Some record.
*/
public record SomeRecord(String someField) {
}
and this pom:
<...
- 5,418
0
votes
2
answers
111
views
Javadoc API as part of larger documentation
One of the nice things about sphinx and python is the relatively simple coupling between API documentation and explanatory documentation in markdown using chapters and sections that give the ...
- 1,473
1
vote
1
answer
200
views
Can't build javadoc anymore after upgrading from JDK 1.6, "path may not be null or empty string"
I used to use the following Gradle task in build.gradle to build Javadocs for my Android app:
task javadoc(type: Javadoc) {
title = "My Docs v${android.defaultConfig.versionName}"
...
- 39.6k
1
vote
1
answer
93
views
What HTML attributes are allowed in Javadoc?
I tried to use the lang attribute on an element in a documentation comment. Doclint (as part of the javadoc command) rejects that. I know I could suppress HTML errors in general, but I want to be told ...
- 1,775
1
vote
0
answers
863
views
After changing the patrykandpatrick/vico library version to 1.13.0 the application compiling FAILED
For my application I am using a chart library patrykandpatrick/vico.
Version 1.12.0 works great. But when I upgrade the version to 1.13.0, an error occurs during compilation:
> Task :app:...
