The poor state of documentation for the IDEA OpenAPI and other problems with
it have been a common source of complaints from IDEA users. The complaints
did not fall on deaf ears. :) I have recently joined the IDEA team as a
developer, and one of my primary responsibilities is improving the OpenAPI,
its documentation and the support we provide for plugin developers.
Eventually we plan to have our entire OpenAPI documented, but given the sheer
volume of the work involved, this isn't likely to happen earlier than the
next major release of IDEA. Because of this, I would like to ask the plugin
developers: What would be the most helpful thing we can provide in the near
term? Do you simply need more javadoc documentation for the OpenAPI classes?
More overview- or tutorial-style articles on plugin development? More samples
for specific areas of the OpenAPI? What specific areas do we need to cover
first in our documentation?
Looking forward to your feedback,
"Develop with pleasure!"