https://github.com/robertoschwald/groovy-dash-generator
Generate Documentation from Java/Groovy source
https://github.com/robertoschwald/groovy-dash-generator
Last synced: about 1 year ago
JSON representation
Generate Documentation from Java/Groovy source
- Host: GitHub
- URL: https://github.com/robertoschwald/groovy-dash-generator
- Owner: robertoschwald
- License: mit
- Created: 2015-10-10T14:24:26.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-10-10T15:54:46.000Z (over 10 years ago)
- Last Synced: 2025-05-08T16:55:23.780Z (about 1 year ago)
- Language: CSS
- Size: 171 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.markdown
- License: LICENSE.markdown
Awesome Lists containing this project
README
# Dash Documentation Generation
This project allows for you to generate documentation from project source. This project uses a modified groovydoc page to remove the navigation and keep the 'look and feel' the same across pages.
To build the tool, you will need to run `./gradlew shadowJar`.
## Usage
java -jar dash--all.jar
### Options
* --output-dir \ : Directory to create the docset in
* --name \ : Name of the docset
* --index \ : Index to start with
* src-directories : Directories to search for source files
Simple example:
java -jar build/dash/libs/dash-0.0.2-SNAPSHOT-all.jar --output-dir build/generated-docs --name foo dash/src/main/java
Running this will generate a file `build/generated-docs/foo.docset`, you can simply add this to Dash.
Detailed example:
java -jar build/dash/libs/dash-0.0.2-SNAPSHOT-all.jar --output-dir build/generated-docs/gradle3 --name gradle --index ~/Downloads/gradle-2.5/docs/dsl `find ~/Downloads/gradle-2.5/src -type d -maxdepth 1 -mindepth 1 -exec echo -n "{} " \;`
This will take about 8 min to run. The find command will get the source root of all the folders, making the dsl links work.
More to come...