https://github.com/qupath/javadoc-viewer
A simple JavaFX Javadoc viewer
https://github.com/qupath/javadoc-viewer
Last synced: 10 months ago
JSON representation
A simple JavaFX Javadoc viewer
- Host: GitHub
- URL: https://github.com/qupath/javadoc-viewer
- Owner: qupath
- License: apache-2.0
- Created: 2024-05-02T13:08:41.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-02T11:42:46.000Z (11 months ago)
- Last Synced: 2025-07-02T12:42:50.492Z (11 months ago)
- Language: Java
- Size: 178 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Javadoc Viewer
A simple JavaFX Javadoc viewer.
## Installing
The repository contains two subprojects:
* One subproject (`javadocviewer`) containing the UI implementation of the Javadoc viewer.
* One subproject (`javadocviewer-app`) to start the UI implementation as a standalone application. It is mainly used for development.
To use the javadoc viewer:
```groovy
// build.gradle
dependencies {
def javadocViewerVersion = "0.1.0-SNAPSHOT"
implementation "io.github.qupath:javadocviewer:${javadocViewerVersion}"
}
```
If you don't use Java modules in your application, you also have to import the `javafx.controls` and `javafx.fxml` modules:
```groovy
// build.gradle
javafx {
version = ...
modules = [ 'javafx.controls', 'javafx.fxml' ]
}
```
Then, take a look at the `JavadocViewerApp` class of `javadocviewer-app` to see
an example on how to use the javadoc viewer.
## Building
You can build every module of the javadoc viewer from source with:
```bash
./gradlew clean build
```
The outputs will be under each subproject's `build/libs`.