Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.
Difference between revisions of "Recommenders/Attic/New and Noteworthy/0.3"
m |
(Prepared ExtDoc presentation) |
||
| Line 7: | Line 7: | ||
[[Image:Recommenders subwords methodnames.png]] | [[Image:Recommenders subwords methodnames.png]] | ||
| − | + | <br> and completion on variable names: | |
| − | and completion on variable names: | + | |
[[Image:Recommenders subwords variablename.png]] | [[Image:Recommenders subwords variablename.png]] | ||
| − | + | <br> and completion on method overrides: | |
| − | and completion on method overrides: | + | |
[[Image:Recommenders subwords methodoverrides.png]] | [[Image:Recommenders subwords methodoverrides.png]] | ||
| − | '''Subwords has been developed by Paul-Emmanuel Faidherbe and contributed to Eclipse Code Recommenders. Thank you Paul-Emmanuel! ''' | + | '''Subwords has been developed by Paul-Emmanuel Faidherbe and contributed to Eclipse Code Recommenders. Thank you Paul-Emmanuel! ''' |
| + | |||
| + | <br> Subwords currently has some limitations: | ||
| + | |||
| + | *It doesn't support dynamic reranking of proposals with better/larger overlaps. | ||
| + | *It only works in the scenarios shown above. Typename completions are yet not possible. | ||
| + | |||
| + | You may find more limitations as you go. Please send your feature requests and bugs to Bugzilla. A thread discussing this contribution is here: https://bugs.eclipse.org/bugs/show_bug.cgi?id=350000 | ||
| + | |||
| + | |||
| + | == ExtDoc - Extended Documentation Platform == | ||
| + | |||
| + | Traditionally, Javadoc is the first place to go if you want to have details regarding API usage. However, Javadoc's quality much depends on the author and therefore often lacks important information. Usually it only informs about arguments and returned information, but seldom puts it into perspective, e.g. its role in the whole framework/library. | ||
| + | |||
| + | The following screenshots indicate how ExtDoc tries to solve this problems. It uses several types of automatically inferred information - displayed by so-called "content providers" - and community features to enrich Eclipse's Java documentation. Furthermore, ExtDoc provides a framework for external contributors to implement own documentation providers. | ||
| + | |||
| + | {| width="900" border="0" cellpadding="1" cellspacing="1" | ||
| + | |- | ||
| + | | valign="top" | '''Method Calls''' | ||
| + | | valign="top" | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc calls.png]] | ||
| + | |||
| + | |- | ||
| + | | valign="top" | '''Code Examples''' | ||
| + | | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc example.png]] | ||
| + | |||
| + | |- | ||
| + | | valign="top" | '''Subclassing Directives''' | ||
| + | | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc subclas.png]] | ||
| + | |||
| + | |- | ||
| + | | valign="top" | '''Subclassing Patterns''' | ||
| + | | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc pattern.png]] | ||
| + | |||
| + | |- | ||
| + | | valign="top" | '''Social Bookmarks''' | ||
| + | | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc bookmar.png]] | ||
| + | |||
| + | |- | ||
| + | | valign="top" | '''ExtDoc in Hovers''' | ||
| + | | | ||
| + | ... | ||
| + | |||
| + | [[Image:Recommenders extdoc hover.png]] | ||
| + | |- | ||
| + | | valign="top" | '''ExtDoc in Content Assistant''' | ||
| + | | | ||
| + | ... | ||
| − | + | [[Image:Recommenders extdoc complet.png]] | |
| − | + | ||
| − | + | ||
| − | + | |} | |
Revision as of 21:51, 11 August 2011
Subwords Completion Engine
Sometimes you just don't know the complete name of a method - or entering its full name from the first character? Subwords is here to assist.
It supports code completion on method names:
and completion on variable names:
and completion on method overrides:
Subwords has been developed by Paul-Emmanuel Faidherbe and contributed to Eclipse Code Recommenders. Thank you Paul-Emmanuel!
Subwords currently has some limitations:
- It doesn't support dynamic reranking of proposals with better/larger overlaps.
- It only works in the scenarios shown above. Typename completions are yet not possible.
You may find more limitations as you go. Please send your feature requests and bugs to Bugzilla. A thread discussing this contribution is here: https://bugs.eclipse.org/bugs/show_bug.cgi?id=350000
ExtDoc - Extended Documentation Platform
Traditionally, Javadoc is the first place to go if you want to have details regarding API usage. However, Javadoc's quality much depends on the author and therefore often lacks important information. Usually it only informs about arguments and returned information, but seldom puts it into perspective, e.g. its role in the whole framework/library.
The following screenshots indicate how ExtDoc tries to solve this problems. It uses several types of automatically inferred information - displayed by so-called "content providers" - and community features to enrich Eclipse's Java documentation. Furthermore, ExtDoc provides a framework for external contributors to implement own documentation providers.
| Method Calls |
...
|
| Code Examples |
...
|
| Subclassing Directives |
...
|
| Subclassing Patterns |
...
|
| Social Bookmarks |
...
|
| ExtDoc in Hovers |
...
|
| ExtDoc in Content Assistant |
...
|
