Bug 314296 - [doc] Some API packages missing from javadoc
Summary: [doc] Some API packages missing from javadoc
Status: RESOLVED WONTFIX
Alias: None
Product: Equinox
Classification: Eclipse Project
Component: p2 (show other bugs)
Version: 3.6   Edit
Hardware: PC Mac OS X - Carbon (unsup.)
: P3 normal (vote)
Target Milestone: ---   Edit
Assignee: Pascal Rapicault CLA
QA Contact:
URL:
Whiteboard: stalebug
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2010-05-25 11:51 EDT by Thomas Watson CLA
Modified: 2019-10-08 10:47 EDT (History)
2 users (show)

See Also:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Thomas Watson CLA 2010-05-25 11:51:31 EDT
While documenting the new p2 packages in the release review slides for Equinox I found the following p2 API packages to be missing from the help javadoc.


org.eclipse.equinox.frameworkadmin
org.eclipse.equinox.p2.core
org.eclipse.equinox.p2.repository.tools.analyzer
org.eclipse.equinox.p2.repository.tools.comparator
org.eclipse.equinox.simpleconfigurator.manipulator
Comment 1 Thomas Watson CLA 2010-05-25 11:52:43 EDT
Marking for RC3 to make sure it does not fall off the radar, but could slip to RC4.
Comment 2 Pascal Rapicault CLA 2010-05-25 20:33:31 EDT
I have fixed org.eclipse.equinox.p2.core because the generation is already setup properly and just the reference from the doc was missing. As for the others I'm not really inclined to fix this right now because 1) they are not relevant for most (any?) users (They serve some scenarios for the eclipse SDK itself or the eclipse build) and 2) setting up the build for javadoc generation always take several iterations which I don't think we have at this point.
What do you think?
Comment 3 Thomas Watson CLA 2010-05-26 11:24:24 EDT
(In reply to comment #2)
> What do you think?

I don't want to risk breaking stuff to add javadoc for obscure API packages, so I am fine with deferring that.

I would like us to consider fixing in 3.6.1.
Comment 4 Thomas Watson CLA 2011-06-08 11:28:56 EDT
Move all 3.8 bugs to Juno.
Comment 5 Eclipse Genie CLA 2019-03-22 17:45:21 EDT
This bug hasn't had any activity in quite some time. Maybe the problem got resolved, was a duplicate of something else, or became less pressing for some reason - or maybe it's still relevant but just hasn't been looked at yet.

If you have further information on the current state of the bug, please add it. The information can be, for example, that the problem still occurs, that you still want the feature, that more information is needed, or that the bug is (for whatever reason) no longer relevant.

--
The automated Eclipse Genie.
Comment 6 Lars Vogel CLA 2019-10-08 10:47:09 EDT
This bug was marked as stalebug a while ago. Marking as wontfix.

If this report is still relevant for the current release, please
reopen and remove the stalebug whiteboard tag.