# Processing JavaDoc index.html
**URL:** https://discourse.processing.org/t/processing-javadoc-index-html/17158
**Category:** Development
**Created:** [January 18, 2020, 3:08pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158 "2020-01-18T15:08:34Z")
**Posts on this page:** 15
**Page:** 1
### Author:  [@Thomas](https://discourse.processing.org/u/Thomas)
#### Post date: [January 18, 2020, 3:08pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/1 "2020-01-18T15:08:34Z")
Hi all,
I’m trying to generate a structured overview of my code in Processing (similar to a JavaDoc I believe). I added some doc comments, after which I do: ‘file --\> export application --\> windows’, from the PDE. According to this reference:
[https://processing.org/reference/doccomment.html](https://processing.org/reference/doccomment.html)
This should then create an index.html file, with the comments in it. This is the file I use to test with:
```auto
void setup(){
size(100,100);
}
void draw(){
exit();
}
/**
This is a description for function T1
@param t temperature
@param tp previous temperature
*/
float calculateT1 (float t, float tp){
return t + tp;
}
```
However, the index.html file is not generated. Am I missing something here? Thanks in advance.
Kind regards,
Thomas
---
### Author:  [@hamoid](https://discourse.processing.org/u/hamoid)
#### Post date: [January 18, 2020, 3:54pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/2 "2020-01-18T15:54:05Z")
I tried and apparently the PDE doesn’t create any documentation. Maybe it used to work in the past?
But it worked doing this:
1. I exported the sketch using the PDE. This created a bunch of folders including java files.
2. I run this command in the root of those folders:
Match the linux32 part with whatever folder it was created when exporting. That creates a `docs/` folder with the documentation coming from the javadoc annotations.
Idea and other IDEs have integrated javadoc I think, so no need for command line work.
---
### Author:  [@Thomas](https://discourse.processing.org/u/Thomas)
#### Post date: [January 18, 2020, 8:23pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/3 "2020-01-18T20:23:12Z")
Thank you @hamoid for your quick response. Unfortunately, this does not work for me. I’m on Windows 10, installed Java and added the JAVA\_HOME system variable to my path (am I missing any other?). I get the following error:
```auto
javadoc : The term 'javadoc' is not recognized as the name of a cmdlet, function, script file, or operable program. Che
ck the spelling of the name, or if a path was included, verify that the path is correct and try again.
At line:1 char:1
+ javadoc -d docs ./application.windows64/source/*java
+ ~~~~~~~
+ CategoryInfo : ObjectNotFound: (javadoc:String) [], CommandNotFoundException
+ FullyQualifiedErrorId : CommandNotFoundException
```
What else can I try? Also, I did not understand the difference between Java jre and jdk? Thanks in advance
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 8:44pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/4 "2020-01-18T20:44:31Z")
I just checked on my Win 10.
javadoc is not part of the jre folder. (Java runtime environment)
[https://www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html](https://www.oracle.com/technetwork/java/javase/documentation/javadoc-137458.html)
It’s only part of the Java 2 SDK. This contains JRE and compiler and debugger (160 MB I think)
[https://www.oracle.com/technetwork/java/javase/install-140406.html](https://www.oracle.com/technetwork/java/javase/install-140406.html)
**PATH**
also when you have javadoc, make sure windows knows the path of it:
(example from another program)
[https://docs.telerik.com/teststudio/features/test-runners/add-path-environment-variables](https://docs.telerik.com/teststudio/features/test-runners/add-path-environment-variables)
---
### Author:  [@Thomas](https://discourse.processing.org/u/Thomas)
#### Post date: [January 18, 2020, 9:03pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/5 "2020-01-18T21:03:44Z")
I installed Java JDK from here:
[https://www.oracle.com/technetwork/java/javase/downloads/jdk13-downloads-5672538.html](https://www.oracle.com/technetwork/java/javase/downloads/jdk13-downloads-5672538.html)
and javadoc is now recognised from the terminal. However, if I run this:
```auto
javadoc -d .\application.windows64\source\*java
```
from the folder where my .pde file is located, I get the following error:
```auto
javadoc: error - No modules, packages or classes specified.
1 error
```
Thank you all for helping me.
Thomas
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 9:06pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/6 "2020-01-18T21:06:48Z")
> [@Thomas](#):
>
> \*java
maybe that’s a spelling error
try `..............*.java `
with dot please
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 9:09pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/7 "2020-01-18T21:09:03Z")
also check out
>
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 9:16pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/8 "2020-01-18T21:16:21Z")
I just downloaded [https://en.wikipedia.org/wiki/Doxygen](https://en.wikipedia.org/wiki/Doxygen)
which works and has a graphical GUI
---
### Author:  [@Thomas](https://discourse.processing.org/u/Thomas)
#### Post date: [January 18, 2020, 9:16pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/9 "2020-01-18T21:16:57Z")
Unfortunately, running `javadoc -d .\application.windows64\source\*.java` gives this error:
```auto
javadoc: error - No modules, packages or classes specified.
1 error
```
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 9:18pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/10 "2020-01-18T21:18:30Z")
check out [https://stackoverflow.com/questions/9993117/how-to-compile-javadoc-from-sources-in-simplest-way](https://stackoverflow.com/questions/9993117/how-to-compile-javadoc-from-sources-in-simplest-way)
---
### Author:  [@hamoid](https://discourse.processing.org/u/hamoid)
#### Post date: [January 18, 2020, 9:30pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/11 "2020-01-18T21:30:02Z")
If you want to do inside Idea: [https://www.jetbrains.com/help/idea/working-with-code-documentation.html#](https://www.jetbrains.com/help/idea/working-with-code-documentation.html#)
---
### Author:  [@Thomas](https://discourse.processing.org/u/Thomas)
#### Post date: [January 18, 2020, 9:32pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/12 "2020-01-18T21:32:21Z")
I downloaded doxygen from here:
[http://www.doxygen.nl/download.html](http://www.doxygen.nl/download.html)
Everything was straightforward from there on.
Strange that this functionality is not included in the Processing IDE 🤔
Thank you so much.
---
### Author:  [@Chrisir](https://discourse.processing.org/u/Chrisir)
#### Post date: [January 18, 2020, 9:48pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/13 "2020-01-18T21:48:16Z")
Great, it works now.
Happy to hear that
I was interested in a tool that points me to
architectural errors.
And shows which class is using which other class (network of dependencies / hierarchy) in a graphical way
An architectural error would be when
- there would be a circle dependency between two classes or
- a class would access an array of the same class on sketch level
---
### Author:  [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [January 30, 2020, 8:37pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/14 "2020-01-30T20:37:00Z")
@Thomas thanks for reporting this.
I’m seeing the same thing on MacOS 10.12 – Processing 3.4 and 3.5.
I have opened an issue in the docs here:
>
>
> Issue description
> The "doc comment" reference page says:
> Explanatory notes embedded within the code and written to the "index.html" file created when the...
---
### Author:  [@jeremydouglass](https://discourse.processing.org/u/jeremydouglass)
#### Post date: [February 3, 2020, 5:46pm UTC](https://discourse.processing.org/t/processing-javadoc-index-html/17158/15 "2020-02-03T17:46:13Z")
As per the issue, it looks like that documentation was long out of date – creating a documentation index.html hasn’t been a PDE feature for a long time:
> that dates back to applet export. It should just be removed
I submitted a pull request to fix it up with mention of javadoc, Doxygen, and IDEs as alternatives.