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

Bug 331406

Summary:	[doc] o.e.help.base API is missing package.html and not listed in ISV docs
Product:	[Eclipse Project] Platform	Reporter:	Martin Oberhuber <mober.at+eclipse>
Component:	User Assistance	Assignee:	Chris Goldthorpe <cgold>
Status:	RESOLVED FIXED	QA Contact:
Severity:	normal
Priority:	P3	CC:	cgold
Version:	3.6
Target Milestone:	3.7 M5
Hardware:	All
OS:	All
Whiteboard:

Description Martin Oberhuber

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

2010-12-14 16:37:09 EST

Fixed in HEAD