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

Bug 387147

Summary:

jsdoc service registry events

Product:

[ECD] Orion

Reporter:

John Arthorne <john.arthorne>

Component:

Client

Assignee:

Michael Rennie <Michael_Rennie>

Status:

RESOLVED FIXED

QA Contact:

Severity:

normal

Priority:

CC:

john.arthorne, mamacdon, Michael_Rennie

Version:

unspecified

Target Milestone:

4.0 RC3

Hardware:

OS:

Windows 7

Whiteboard:

Attachments:

Description	Flags
updates JSDoc	none
updated memberof sections	none

Description John Arthorne

2012-08-13 16:05:52 EDT

1.0 M1

serviceregistry.js defines add/removeEventListener methods, but doesn't document what kinds of events are available. This script should have @event jsdoc to document the available event types.

Comment 1 Michael Rennie

2013-10-08 12:56:11 EDT

Created attachment 236232 [details]
updates JSDoc

The patch adds the @event doc for the three events: modified, registered, and unregistering. It also updates the doc on the two functions to be better JSDoc formatted, using: @name, @description, @public, @memberOf, and @function

Comment 2 Michael Rennie

2013-10-09 11:55:16 EDT

Created attachment 236296 [details]
updated memberof sections

Updated the memberof sections to mention SeviceRegistry.prototype rather than just the class name.

Comment 3 Michael Rennie

2013-10-21 12:34:34 EDT

(In reply to Michael Rennie from comment #2)
> Created attachment 236296 [details]
> updated memberof sections
> 
> Updated the memberof sections to mention SeviceRegistry.prototype rather
> than just the class name.

To make life a bit easier I open a pull request: https://github.com/eclipse/orion.client/pull/28

Comment 4 Michael Rennie

2013-10-23 12:22:52 EDT

(In reply to Michael Rennie from comment #3)
> (In reply to Michael Rennie from comment #2)
> > Created attachment 236296 [details]
> > updated memberof sections
> > 
> > Updated the memberof sections to mention SeviceRegistry.prototype rather
> > than just the class name.
> 
> To make life a bit easier I open a pull request:
> https://github.com/eclipse/orion.client/pull/28

I couldn't find a good way to update the pull request from github, so I pushed the updated doc to Gerrit: https://git.eclipse.org/r/17694

I removed the use of the @event tag because when the doc is created they all show up in an events section (GOOD) but are doc'd to look like functions, which in this case they are not (BAD). So instead I added comments on the addEventListener and related methods about the three types of events they can register for.

Comment 5 Mark Macdonald

2013-10-23 16:01:24 EDT

Added a couple of comments to Gerrit.

Comment 6 Michael Rennie

2013-10-24 14:55:29 EDT

This was merged via Gerrit.