Stack Overflow
Stack Overflow

Questions tagged [javadoc]

Javadoc is an extensible documentation generation system which reads specially formatted comments in Java source code and generates compiled documentation. It is typically used to produce API documentation in the form of HTML web pages.

Javadoc is an extensible documentation generation system which reads specially formatted comments in Java source code and generates compiled documentation. It is typically used to produce API documentation in the form of HTML web pages.

A Javadoc comment starts with /** (an extra star to the normal multi-line comment) and ends with */. It also makes use of tags (starting with @).

Resources

2947 questions
1
vote
0 answers

Attempting to generate javadoc in Eclipse but getting "Error=193, %1 is not a valid Win32 application"

I'm working on an assignment and having trouble generating a javadoc html file for this class I've made. I've clicked Project > Generate Java Doc > Javadoc command auto filled to C:\Users\Evanl\workspace\CSC - Car Class\bin\Main\Car.class > click…
Evan
  • 11
  • 3
1
vote
0 answers

Add user generated comments to existing javadoc

Our team develops software for BlackBerry devices. The BlackBerry API (javadocs) is poorly documented, and sometimes even outdated. What we would like to do is import this existing documentation into an online system that could then be…
Adwiv
  • 1,283
  • 9
  • 15
1
vote
1 answer

why does eclipse show an error message when using the javadoc tag @param when commenting?

I was typing some code in eclipse and as soon as I start to use the javadoc @param tag the IDE show me an error mark as seen in the picture. When I use the given solution from eclipse, the IDE corrects for example @param board to @paramboard but…
Heracless123
  • 15
  • 3
1
vote
1 answer

How to generate external link to 3rd party classes with Javadoc

I'm trying to use links to 3rd party libraries in my Java class docs, however javadoc tool cannot generate a link. /** * A link to 3rd party lib class {@link dagger.Lazy} */ public class MyCLass { /** * main desc */ static public…
Rom098
  • 2,445
  • 4
  • 35
  • 52
1
vote
0 answers

JavaDoc getDocComment() doesn't work if there is an annotation on the element

I am trying to use the getDocComment method to grab some javadoc from a variable declaration, however when there is an annotation between the comment and element then getDocComment returns null For example: /** * A description of varA */ private…
Tom Delebo
  • 21
  • 2
1
vote
0 answers

Stage failing on Jenkins even though the logs says it was successfull

I have a stage in my Jenkins pipeline to generate and publish the javadoc of my application but for some reason when I run it the build fails because of that stage as it is possible to see in the below screenshot When I consult the log to see…
Fábio Pires
  • 71
  • 6
1
vote
0 answers

dokka mess up markdown in javadoc

I am trying to find a way to enable me to use markdown in the Javadoc of my java source code. I tried markdown-doclet, and it works perfectly previously. However, it stops working after java 8, e.g. java 11. I want to give dokka a try. It generates…
Gelin Luo
  • 14,035
  • 27
  • 86
  • 139
1
vote
1 answer

Generating JavaDocs?

It's been a while since I have generated JavaDocs, and I'm sure the options have improved in the last 10 years or so. Can I get some suggestions of a generator that will output JavaDocs similar to the .Net document structure, ie. this…
ElHaix
  • 12,846
  • 27
  • 115
  • 203
1
vote
0 answers

GitHub: How to test a custom GitHub Action

Introduction I'm currently working on a GitHub Action that automatically generates a JavaDoc and publishes it to GitHub Page. The GitHub project: https://github.com/MathieuSoysal/jib-container-publish.yml Problem This custom GitHub Action does not…
ThrowsError
  • 1,169
  • 1
  • 11
  • 43
1
vote
0 answers

java.lang.OutOfMemoryError: Please increase memory

I have been working on JDK11 Migration, when i build my package , javadoc throwing the following error. > -standard-javadoc: [ht:javadoc] Generating Javadoc [ht:javadoc] Javadoc execution [ht:javadoc] Picked up JAVA_TOOL_OPTIONS:…
sachin shukla
  • 11
  • 1
1
vote
1 answer

how to load a jar package in a maven plugin

I have created a maven plugin, the plugin will parse java source code and submit the results to my console. But now I have a problem, some java classes are written by a third-party or by other groups at my company, then my plugin can't get these…
jerry.yang
  • 11
  • 1
1
vote
2 answers

Documentation not visible in Javadoc

I have the following function: /** * @param parent ... * @param key ... * @param isRed ... * ... */ public redBlackNode(redBlackNode parent, int key, boolean isRed) { ... } I can't see it (or anything else that I documented) in my…
das
1
vote
0 answers

How to show javadoc in VScode?

I'm currently using Ubuntu Linux. When I used to program on windows using eclipse, I could easily open javadoc when I hover over a function or when I press control and click it. Now I'm using VS code, and I can't see javadoc for some reason. When I…
Mr.Aflaton
  • 11
  • 1
1
vote
0 answers

Unable to compile spark due to attach-javadoc

Goal and Problem I'm trying to compile a minimal version of spark to get our container size down. We only use spark-sql and pyspark. Here's the dockerfile I've been using FROM openjdk:20-bullseye RUN apt-get update && \ apt-get install git -y…
FailureGod
  • 332
  • 1
  • 12
1
vote
1 answer

How to provide generated data-binding classes in a Gradle Javadoc task?

With this Gradle task I've used to extract AAR, in order to generate Javadoc: task javadoc(type: Javadoc) { doFirst { configurations.implementation.filter { it.name.endsWith('.aar') }.each { aar -> copy { from…
Martin Zeitler
  • 1
  • 19
  • 155
  • 216
1 2 3
…
99
100