Bug 435826 - org.eclipse.debug.ui.stringsubstitution is missing in generated API doc
Summary: org.eclipse.debug.ui.stringsubstitution is missing in generated API doc
Status: VERIFIED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Debug (show other bugs)
Version: 4.3   Edit
Hardware: All All
: P3 normal (vote)
Target Milestone: 4.4 RC3   Edit
Assignee: Sarika Sinha CLA
QA Contact:
URL:
Whiteboard:
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2014-05-26 14:53 EDT by Markus Keller CLA
Modified: 2015-03-17 02:54 EDT (History)
1 user (show)

See Also:
Michael_Rennie: review+

Attachments
Added Details in platform and jdt doc.isv (3.69 KB, patch)
2014-05-27 08:11 EDT, Sarika Sinha CLA 		no flags Details | Diff
Added package.html for stringsubstitution (880 bytes, patch)
2014-05-27 08:13 EDT, Sarika Sinha CLA 		no flags Details | Diff
View All 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 Markus Keller CLA 2014-05-26 14:53:08 EDT 
org.eclipse.debug.ui.stringsubstitution is missing in generated API doc.

See https://wiki.eclipse.org/index.php/How_to_add_things_to_the_Eclipse_doc
Comment 1 Markus Keller CLA 2014-05-26 15:46:02 EDT 
Also missing:
org.eclipse.jdt.debug.ui.actions
Comment 2 Sarika Sinha CLA 2014-05-27 08:11:52 EDT 
Created attachment 243532 [details]
Added Details in  platform and jdt doc.isv
Comment 3 Sarika Sinha CLA 2014-05-27 08:13:26 EDT 
Created attachment 243533 [details]
Added package.html for stringsubstitution

Added the API details for jdt and platform debug as described in the wiki.
Comment 5 Markus Keller CLA 2014-05-28 09:31:51 EDT 
http://download.eclipse.org/eclipse/downloads/drops4/I20140527-2000/compilelogs/platform.doc.isv.javadoc.txt now says (in addition to bug 435521):

../../../eclipse.platform.debug/org.eclipse.debug.ui/ui/org/eclipse/debug/ui/stringsubstitution/IArgumentSelector.java:35: warning - @param argument "the" is not a parameter name.

Fixed with http://git.eclipse.org/c/platform/eclipse.platform.debug.git/commit/?id=2a8acdcd1ebc1341f3d4498a0143450267700778

You should consider enabling Project Properties > Java Compiler > Javadoc. Didn't do that for RC3, since proper settings result in hundreds of warnings.
Comment 6 Sarika Sinha CLA 2015-03-17 02:54:14 EDT 
Verified using
Eclipse SDK

Version: Mars (4.5)
Build id: I20150316-2000