OpenAPI Documentation

Looking in the docs I find the section on the OpenAPI that reads as follows:

"Documentation about IDEA's Open API can be found in the doc/openapi
folder of the IDEA installation."

However, for the past 10 or so builds there has been NOTHING in the doc
directory at all.

Theres now some .jar files including all the javadocs in the ./help
directory but no docs.

Mark

6 comments
Comment actions Permalink

You have to download that seperately. It is the -dev.zip file.

eg: idea2178-dev.zip

0
Comment actions Permalink

Claus Ibsen wrote:

You have to download that seperately. It is the -dev.zip file.

eg: idea2178-dev.zip


I beg to differ. that file DOES NOT contain doc/*

It contains help, lib, and plugins. Theres an openapihelp.jar for sure.
But no easy way to open it up without uncompressing it first.

And I was also pointing out the documentation was wrong.

0
Comment actions Permalink

And I was also pointing out the documentation was
wrong.

Yep documentation has never been the strong side of IDEA.
Sorry for missing yor point.

/Claus

0
Comment actions Permalink

Hello Mark,

Looking in the docs I find the section on the OpenAPI that reads as
follows:

"Documentation about IDEA's Open API can be found in the doc/openapi
folder of the IDEA installation."

However, for the past 10 or so builds there has been NOTHING in the
doc directory at all.

Theres now some .jar files including all the javadocs in the ./help
directory but no docs.

Mark


Well, documentation is light because you're using EAP builds -- the documentation is still being written.... however, more information about available APIs (for writing plugins, as I'm guessing that's what you want to do) can be found at:

http://www.intellij.org/twiki/bin/view/Main/IntelliJPluginsHome

Otherwise, be patient my friends ... documentation is coming....

David
JetBrains, Inc.
"Develop with pleasure!"

0
Comment actions Permalink

Hi,


Well, documentation is light because you're using EAP
builds -- the documentation is still being


I downloaded the 4.5 release of IDEA, but there is no OpenAPI docs (no /doc directory)

How "Open" is this API, really?

written.... however, more information about available
APIs (for writing plugins, as I'm guessing that's
what you want to do) can be found at:

http://www.intellij.org/twiki/bin/view/Main/IntelliJPl
ginsHome


I couldn't find any useful info on the API here.

0
Comment actions Permalink

Otto wrote:

Hi,

>>Well, documentation is light because you're using EAP
>>builds -- the documentation is still being


I downloaded the 4.5 release of IDEA, but there is no OpenAPI docs (no /doc directory)

How "Open" is this API, really?

>>written.... however, more information about available
>>APIs (for writing plugins, as I'm guessing that's
>>what you want to do) can be found at:
>>
>>http://www.intellij.org/twiki/bin/view/Main/IntelliJPl
>>ginsHome


I couldn't find any useful info on the API here.

You need to download the Plugin Development Package available at:
http://www.jetbrains.com/idea/download/index.html

0

Please sign in to leave a comment.