Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 331406 - [doc] o.e.help.base API is missing package.html and not listed in ISV docs
Summary: [doc] o.e.help.base API is missing package.html and not listed in ISV docs
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: User Assistance (show other bugs)
Version: 3.6   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 3.7 M5   Edit
Assignee: Chris Goldthorpe CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-11-30 04:36 EST by Martin Oberhuber CLA
Modified: 2010-12-14 16:37 EST (History)
1 user (show)

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 Martin Oberhuber CLA 2010-11-30 04:36:29 EST 
The org.eclipse.help.base API package is lacking a package.html file, and it is not listed in the ISV docs.
http://help.eclipse.org/helios/topic/org.eclipse.platform.doc.isv/reference/api/overview-summary.html

I think that this process must be followed for adding the new API package:
http://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc

A hyperlink to AbstractHelpScope should be used here:
http://help.eclipse.org/helios/topic/org.eclipse.platform.doc.isv/guide/ua_help_abstract_scope.htm

Incorrect "AbstractScope" should be replaced by "AbstractHelpScope" here:
http://help.eclipse.org/helios/topic/org.eclipse.platform.doc.isv/reference/extension-points/org_eclipse_help_base_scope.html

The scope.exsd should indicate that AbstractHelpScope must be subclassed.
Comment 1 Chris Goldthorpe CLA 2010-12-14 16:37:09 EST 
Fixed in HEAD