Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 366984 - Content assist doc needs updating
Summary: Content assist doc needs updating
Status: RESOLVED FIXED
Alias: None
Product: Orion
Classification: ECD
Component: Doc (show other bugs)
Version: 0.4   Edit
Hardware: PC Windows 7
: P3 normal (vote)
Target Milestone: 0.4 M2   Edit
Assignee: John Arthorne CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-12-16 16:16 EST by John Arthorne CLA
Modified: 2011-12-19 16:39 EST (History)
0 users

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description John Arthorne CLA 2011-12-16 16:16:44 EST 
0.4 M1

The documentation on content assist is missing details on how to write more complex proposal engines. It should have this detail:

 The event.proposal may be either a simple string or an object with this shape:
 {   proposal: "[proposal string]", // Actual text of the proposal
     description: "description", // Optional description to display
     positions: [{
         offset: 10, // Offset of start position of parameter i
         length: 3  // Length of parameter string for parameter i
     }], // One object for each parameter; can be null
     escapePosition: 19 // Offset that caret will be placed at after exiting Linked Mode; can be null
 }
 Offsets are relative to the text buffer.
/