https://github.com/i-al-istannen/javadocindexer
Indexes source code, creates a database with extracted javadoc information and provides query and HTML/MD conversion utilities.
https://github.com/i-al-istannen/javadocindexer
code-analysis java javadoc spoon
Last synced: 3 months ago
JSON representation
Indexes source code, creates a database with extracted javadoc information and provides query and HTML/MD conversion utilities.
- Host: GitHub
- URL: https://github.com/i-al-istannen/javadocindexer
- Owner: I-Al-Istannen
- License: mit
- Created: 2022-11-20T16:19:43.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-11-02T17:29:56.000Z (12 months ago)
- Last Synced: 2025-05-13T15:18:19.056Z (5 months ago)
- Topics: code-analysis, java, javadoc, spoon
- Language: Java
- Homepage:
- Size: 110 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# JavadocIndexer
This is an indexer for java code, extracting information about javadoc elements
directly from the source code. This allows it to build a database with an
easier to parse and render representation of javadoc, acting as the backend for
other tools ([DocTor](https://github.com/I-Al-Istannen/DocTor)).
# Usage
## Setup
To run the indexer, you need to first set up its dependencies:
- clone my fork of [Spoon](https://github.com/I-Al-Istannen/spoon) and checkout
the `feat/javadoc` branch.
- `cd spoon/spoon-pom && mvn clean install`
Afterwards you can build the indexer using `mvn package`.
## Running
`java19 --enable-preview -jar target/JavadocIndexer.jar `
You can find example config files in `src/main/resources/examples`.
An example config could look like
```toml
# Where to store the database
output_path = "target/Paper-Api-Index.db"
# What files to index
resource_paths = ["indexes/paper/Paper-API/src/main/java"]
# The packages to include in the index.
# A single star matches everything, but no support for globbing exists.
# Subpackages are automatically allowed as well.
allowed_packages = [
"*",
]
# The files containing dependencies. Maven is supported by specifying the
# pom.xml files. Gradle is a bit more complicated but might work if you specify
# your project *directories*
build_files = [
"indexes/paper/",
]
# Path to your maven binary
maven_home = "/opt/maven"
# Java home to use for gradle. Can be omitted, then the JVM running your
# indexer will be chosen
java_home = "/usr/lib/jvm/java-17-openjdk"
```