https://github.com/dploeger/intellij-api-doc
Unofficial generated API documentation of IntelliJ Community edition
https://github.com/dploeger/intellij-api-doc
api-documentation documentation intellij intellij-idea intellij-platform javadoc
Last synced: about 1 year ago
JSON representation
Unofficial generated API documentation of IntelliJ Community edition
- Host: GitHub
- URL: https://github.com/dploeger/intellij-api-doc
- Owner: dploeger
- License: mit
- Created: 2017-12-19T14:18:42.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2020-03-13T21:19:08.000Z (over 6 years ago)
- Last Synced: 2025-04-03T08:22:17.091Z (about 1 year ago)
- Topics: api-documentation, documentation, intellij, intellij-idea, intellij-platform, javadoc
- Language: Shell
- Homepage: https://dploeger.github.io/intellij-api-doc/
- Size: 23 MB
- Stars: 4
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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](https://travis-ci.org), 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](http://docker-sync.io/) can be used to speed up performance. Use `bash run-macos.sh` there.