History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: IDEADEV-22134
Type: Task Task
Status: Open Open
Priority: Normal Normal
Assignee: Dmitry Jemerov
Reporter: Eugene Kirpichov
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
IDEA: Development

Provide documentation or examples for run configuration-related openapi

Created: 04 Oct 07 14:59   Updated: 05 Oct 07 17:44
Component/s: Documentation, Plugin Support. API, Plugin Support. DevKit
Fix Version/s: None

Original Estimate: Unknown Remaining Estimate: Unknown Time Spent: Unknown

Build: 7,323
Severity: High


 Description  « Hide
I am trying to write a plugin for the Omniscent Debugger (http://www.lambdacs.com/debugger/) and I want to create a corresponding run configuration.

The com.intellij.execution.configurations.* classes don't have a single line of javadoc or meaningful inline comments in them and I don't have a clue on how to create such a plugin.
The openapi sources don't help much because the abstract methods also don't have javadoc and don't have implementations, so I can't have a look at what the method is supposed to do and where to get the relevant information (like, main class) from.

I guess that the minimal sufficient documentation for me would include information on when and how should one create run configurations, what information should one provide and where to get it from, brief javadocs for abstract methods and some documentation saying which properties of classes like JavaCommandLine are required and which are not.

An even better variant would be to open-source some simple run configuration plugin, for example, JUnit.



 All   Comments   Work Log   Change History      Sort Order:
Dmitry Jemerov - 04 Oct 07 15:06

Eugene Kirpichov - 04 Oct 07 15:13
Wow, thanks, I'll have a look.

Eugene Kirpichov - 04 Oct 07 15:32
I had a look and the plugin is far from being compileable. Even the most important parts for me are crammed with non-openAPI calls that I can't make from my own plugin, so it is of some use, but of too little.

Dmitry Jemerov - 04 Oct 07 15:35
Well, it's definitely compileable - it's compiled for every build of IDEA. You just need to add idea.jar to the IDEA JDK classpath.

Eugene Kirpichov - 04 Oct 07 15:55
Hm, really; thanks. I thought it should be compileable with the plugin devkit alone.

Sascha Weinreuter - 05 Oct 07 17:03
Dmitry, don't you think it's time to add idea.jar automatically? This is for sure the most frequent problem for plugin-beginners...

Dmitry Jemerov - 05 Oct 07 17:05
We prefer to have at least some incentives left for removing closed API dependencies in our plugins.

Eugene Kirpichov - 05 Oct 07 17:08
Maybe, then, provide an intention "add idea.jar to classpath"?

Sascha Weinreuter - 05 Oct 07 17:44
This wouldn't be a problem if the Dependency Analyser supported JAR-scopes (I remotely rember having asked about this somewhere some time ago, although I cannot find a JIRA request)