Skip to main content
Jump to: navigation, search

Difference between revisions of "Recommenders/Attic/New and Noteworthy/0.3"

m (Not released.)
(Removing all content from page)
 
(25 intermediate revisions by 3 users not shown)
Line 1: Line 1:
== Not released. ==
 
  
This version is work-in progress.
 
 
== 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:
 
 
[[Image:Recommenders subwords methodnames.png]]
 
 
<br> and completion on variable names:
 
 
[[Image:Recommenders subwords variablename.png]]
 
 
<br> and completion on method overrides:
 
 
[[Image:Recommenders subwords methodoverrides.png]]
 
 
'''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
 
 
<br>
 
 
== 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. ExtDoc providers are displayed in an own view, when hovering elements in the editor and as additional information to code assistant selections. Furthermore, ExtDoc provides a framework for external contributors to implement own documentation providers being displayed along with the existent ones.
 
 
Of course, standard Javadoc remains available as one information provider. The providers order can be modified by the user simply by drag-and-drop of the providers in the left area of the view.
 
 
{| width="100%" border="0" cellpadding="1" cellspacing="1"
 
|-
 
| valign="top" | '''Method Calls'''
 
| valign="top" |
 
The method calls providers displays statistics about which methods of a type are called most often. This is either context-independent, e.g. when you click on a type name in the editor, or it's context-dependent, e.g. you select a variable. In the latter case it's considered what you've already called, which usually affects the probabilities of the remaining methods.
 
 
[[Image:Recommenders extdoc calls.png|600px]]
 
 
|-
 
| valign="top" | '''Code Examples'''
 
|
 
Code examples are multi-line code snippets found in Java libraries.
 
 
[[Image:Recommenders extdoc example.png|600px]]
 
 
|-
 
| valign="top" | '''Subclassing Directives'''
 
|
 
Subclassing directives indicate which methods of the superclass are typically overwritten. When an overriden method is selected, which methods of the superclass are typically called from the method implementations.
 
 
[[Image:Recommenders extdoc subclas.png|600px]]
 
 
|-
 
| valign="top" | '''Subclassing Patterns'''
 
|
 
Often there are several ways of extending a type, depending on it's purpose, i.e. subgroups of subclassing directives go together. This providers displays information of subclassing patterns found in Java libraries.
 
 
[[Image:Recommenders extdoc pattern.png|600px]]
 
 
|-
 
| valign="top" | '''Social Bookmarks'''
 
|
 
From the screenshots above you should have recognized that users are allowed to rate and comment information. For further user interaction, the social bookmarks provider allows sharing links relevant to the selected packages, types, methods etc.
 
 
[[Image:Recommenders extdoc bookmar.png|600px]]
 
 
|-
 
| valign="top" | '''ExtDoc in Hovers'''
 
|
 
ExtDoc information can not only be displayed in its view, it's also available when hovering editor elements. The icons at the bottom allow quick jumps to the single providers.
 
 
[[Image:Recommenders extdoc hover.png|600px]]
 
 
|-
 
| valign="top" | '''ExtDoc in Content Assistant'''
 
|
 
Furthermore, ExtDoc providers are also displayed when selecting completion proposals in code assistant.
 
 
[[Image:Recommenders extdoc complet.png|750px]]
 
 
|}
 
 
Further content providers are currently in development. Please feel free to comment on the current ones or send requests for further providers!
 
 
== Call Recommenders  ==
 
 
{| width="100%" border="0" cellpadding="1" cellspacing="1"
 
|-
 
| valign="top" | '''Calls Models Info and Update Policies'''
 
| valign="top" | Starting from Version 0.3, Code Recommenders does not bundle all models in one large zip file but downloads them on demand. On startup, it also checks for updates. Means to upload anonymized usage data is currently under review by the Eclipse Technology PMC.
 
 
With 0.3, self-generated models can be configured to support custom/in-house frameworks Code Recommenders has no data for.
 
 
[[Image:Recommenders calls model updates.png]]
 
|}
 

Latest revision as of 02:30, 26 September 2013

Back to the top