"Open API" API online resource?

hello,

i am looking for the API docs of Open API (for CE 10)... can't find anything online. strangely the plugin development tutorials occasionally link to the java sources, but the javadocs don't seem to be anywhere?

thanks, -sciss-

4 comments
Comment actions Permalink

Hi Hanns,

I don't think the Javadocs are online anywhere now that the source code is open.

Cheers,
Colin

0
Comment actions Permalink

Ok, but then how do i generate them from the sources? I checked out the sources, but there is only one ant target "all". i run it, it compiles for a while, but it doesn't create any sorts of javadocs?

best, -sciss-

0
Comment actions Permalink

Hello Hanns,

Open the project in IDEA and use Tools | Generate JavaDoc...

Ok, but then how do i generate them from the sources? I checked out
the sources, but there is only one ant target "all". i run it, it
compiles for a while, but it doesn't create any sorts of javadocs?


--
Dmitry Jemerov
Development Lead
JetBrains, Inc.
http://www.jetbrains.com/
"Develop with Pleasure!"


0
Comment actions Permalink

hello dmitry,

thanks that actually worked! i didn't know how to specify particular packages, so i ended up building the docs for the whole project. i needed to remove some folders which caused javadoc to exit with errors:

  • plugins/cvs   // this is probably some orphaned folder??
  • java/java-tests
  • plugins/InspectionGadgets/test
  • plugins/groovy/testdata
  • plugins/IntentionPowerPak/test
  • samples/comparingReferences/testData
  • samples/conditionalOperatorConvertor/testData
  • plugins/spellchecker/testData
  • plugins/testng/testData
  • plugins/IdeaTestAssistant/testData
  • plugins/ui-designer/testData
  • tools/lexer/jflex-1.4/examples/java
  • plugins/devkit/src/dom
  • plugins/android/src/org/jetbrains/android/dom
  • platform/util/src/com/intellij/util/xmlb/annotations
  • plugins/ant/src/com/intellij/lang/ant/dom
  • plugins/maven/src/main/java/org/jetbrains/idea/maven/dom
  • platform/lang-impl/src/com/intellij/openapi/roots/impl
  • plugins/relaxng/src/org/intellij/plugins/relaxNG/xml/dom


I just later saw that there is a "Include test sources" which was checked by default, maybe i could have spared the rm action by unchecking this in the first place.

I had to put 2048 MB in the max heap field. Also I wanted to use @use because it is very nice to have, but that caused a null pointer exception in javadoc at some point, so i had to uncheck it again.

But then it worked.

best, -sciss-

0

Please sign in to leave a comment.