javadoc Generator

Javadoc Generator is an extension to VSCode that wraps the commandline javadoc compiler. I wrote this in highschool and was originally created to fill my own needs for quickly creating a javadoc. But after over 25k downloads, I decided to rebuild this extension with better error reporting and transparent configuration.

Usage

You will first need a JDG Config file. You can get one by clicking on your project folder and clicking "JDG: Initialize Config file".

Adjust the config file until a valid command is generated with no errors.

You can exclude folders in the specified base_path by adding to the exclude array. This array matches strings directly, using the string prototype's includes() method.

Once a valid javadoc command is created, click the button in the top right corner labled "JDG: Generate Javadoc".

Once the Javadoc generation is complete, you should see the output appended to the config file.

All Configuration Options

Issues

If you find issues, and you probably will, you can report them here. Please include the config.jdgenerator file with your issue report.

Release Notes

3.0.7

• Better javadoc executable locating from issue #30

3.0.5 - 3.0.6

• "raw_params" config added from issue #31
• Readme updates with config descriptions

3.0.2 - 3.0.4

• switches to JSON for more complex configuration
• adds exclude array as requested by issue #28
• Readme updates

3.0.0

• Complete rebuild
• Adds config.jdgenerator for better transparency
• Config validation and error reporting
• Shows the generated Javadoc command in the config.jdgenerator
• Appends Javadoc output to config file for easy submission to GitHub Issues