Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.

Bug 19833

Summary: Missing documentation for extension points
Product: [Eclipse Project] Platform Reporter: Tod Creasey <Tod_Creasey>
Component: DocAssignee: Nick Edgar <n.a.edgar>
Status: RESOLVED FIXED QA Contact:
Severity: critical    
Priority: P1 CC: eduardo_pereira, Kevin_Haaland, n.a.edgar, Randy_Giffen, susan_franklin
Version: 2.0   
Target Milestone: 2.0 F4   
Hardware: PC   
OS: Windows 2000   
Whiteboard:

Description Tod Creasey CLA 2002-06-10 14:54:55 EDT 
Our extension point doc is missing for the following points we define in the 
plugin.xml for org.eclipse.ui.

acceleratorSets
aceleratorConfigurations
acceleratorScopes
actionDefinitions
markerImageProviders (only if this is now API)
markerUpdaters
documentProviders
startup


These are missing entries for certain attributes

perspective 
   default, singleton

preferencePage
   icon

propertyPages
   value

editors
   extendedType

views
   accelerator (do we even use this anymore)?

viewActions, editorActions
   definitionId, description, retarget,allowLabelUpdate

editors
  icon,extendedType
  OBSOLETE IN DOC: contributorClass

newWizard
  enablesFor
Comment 1 Susan Franklin CLA 2002-06-20 00:57:11 EDT 
The doc for markerResolution is named markerResolutions.html (with an s)
The HTML title is wrong also.
The title and file name should be switched to markerResolution
Comment 2 Nick Edgar CLA 2002-06-20 12:06:24 EDT 
Randy, could you please fix up the markerResolution doc?
Comment 3 Randy Giffen CLA 2002-06-20 12:20:30 EDT 
Released fixes to marker resolution doc
Comment 4 Eduardo Pereira CLA 2002-06-20 12:30:03 EDT 
Released docs for acceleratorSets, aceleratorConfigurations, acceleratorScopes, 
actionDefinitions and startup.
Comment 5 Randy Giffen CLA 2002-06-20 12:43:54 EDT 
contributorClass is still needed and the editor doc describing its use looks OK
Comment 6 Simon Arsenault CLA 2002-06-21 10:29:42 EDT 
editors => extendedType - Not reference anywhere in the code. I think this is 
some left over experimental code. Can we remove it?

viewActions/editorActions => definitionId - Not a supported attribute yet. 
Maybe in the future when key binding is more "real".

viewActions/editorActions => description - Not a supported element. We do not 
show descriptions for these actions in the UI (but we do for Action Sets, which 
is why it has a decription element)

viewActions/editorActions => retarget/allowLabelUpdate - Not a supported 
attribute. These attributes make no sense for viewActions. For editorActions, 
it would, but the better way is to use action set part associations instead.

editors => icon - Is in the document already.
Comment 7 Nick Edgar CLA 2002-06-21 10:51:31 EDT 
These should all be fixed up in the extension point doc.
If an attribute applies in some contexts but not others, that should be stated.
Comment 8 Nick Edgar CLA 2002-06-21 10:52:59 EDT 
cc'ing KH.
Comment 9 Simon Arsenault CLA 2002-06-21 11:16:54 EDT 
Just to clarify my comment above. The extension point doc is correct in that it 
does not include these attributes. Some attributes exist in the code as 
constants but are either not reference anywhere in the code or only used by 
specific readers (i.e the abstract actions reader has the description element 
contants but only the action set reader does anything with it).

So the documentation is correct.
Comment 10 Nick Edgar CLA 2002-06-21 12:53:47 EDT 
Could you please capture the required code fixups in a separate PR?
Comment 11 Simon Arsenault CLA 2002-06-25 15:38:24 EDT 
All needed changes to the documentation were done.