Unofficial generated API documentation of IntelliJ Community edition
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
intellij-community @ 4b2b4b2
.gitignore
.gitmodules
.travis.yml
LICENSE
README.md
docker-compose.yml
docker-sync.yml
mkdocs.sh
run-linux.sh
run-macos.sh
run-travis.sh

README.md

intellij-api-doc

Unofficial generated API documentation of IntelliJ Community Edition

Introduction

This repository contains a submodule to the official IntelliJ Community Edition sources and a documentation generator script that will run javadoc on all sources and packages included in IntelliJ Community Edition (excluding test packages)

Usage

This repository is usually used via Travis, but if you want to create the docs locally, clone the repository and run

bash mkdocs.sh

This should work on all unixoid operating systems. (Tested on Linux with OpenJDK9 and macOS with Oracle JDK 8)

If you'd like to use the same environment travis uses, you can run the build in a docker container. For linux (or nodes, that support native docker), run: bash run-linux.sh. For macOS nodes, docker-sync can be used to speed up performance. Use bash run-macos.sh there.