Bug 231399 - [ds] javadoc for org.eclipse.pde.ds.core
Summary: [ds] javadoc for org.eclipse.pde.ds.core
Status: RESOLVED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: Incubators (show other bugs)
Version: 3.4   Edit
Hardware: PC Windows XP
: P2 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Rafael Oliveira Nóbrega CLA
QA Contact:
URL:
Whiteboard:
Keywords: contributed
Depends on:
Blocks:
 
Reported: 2008-05-09 18:35 EDT by Chris Aniszczyk CLA
Modified: 2008-07-24 16:16 EDT (History)
1 user (show)

See Also:


Attachments
IDSComponent javadoc (2.91 KB, text/plain)
2008-05-20 10:16 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
mylyn/context/zip (926 bytes, application/octet-stream)
2008-05-20 10:16 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
IDSObject, IDSProperty and IDSProperties javadocs (6.29 KB, text/plain)
2008-05-21 14:10 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
IDSService, IDSProvide, IDSReference and IDSImplementation updates (11.37 KB, text/plain)
2008-05-21 15:37 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
IDSReference updates (1.72 KB, text/plain)
2008-05-22 10:45 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
IDSModel and IDSDocumentFactory javadocs (4.59 KB, text/plain)
2008-05-22 14:06 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
javadocs for core.ds concrete classes 1/2 (11.74 KB, text/plain)
2008-05-22 19:05 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details
javadocs for core.ds concrete classes 2/2 (7.43 KB, text/plain)
2008-05-22 19:05 EDT, Rafael Oliveira Nóbrega CLA
caniszczyk: iplog+
Details

Note You need to log in before you can comment on or make changes to this bug.
Description Chris Aniszczyk CLA 2008-05-09 18:35:05 EDT
The whole DS core plug-in needs to be well javadoc'd, especially the interfaces.
Comment 1 Chris Aniszczyk CLA 2008-05-12 21:40:38 EDT
upping priority
Comment 2 Chris Aniszczyk CLA 2008-05-17 11:22:46 EDT
Rafael, I updated the project settings in org.eclipse.pde.ds.core to include flagging warnings for missing javadoc.

I'm particularly interested in the 'org.eclipse.pde.internal.ds.core' interfaces.

Let me know if you have any questions.

This will be probably the last painful thing to do, then we can get back to the fun UI stuff :)
Comment 3 Rafael Oliveira Nóbrega CLA 2008-05-20 10:16:18 EDT
Created attachment 101041 [details]
IDSComponent javadoc

Chris,

could you give me a feedback about this first javadoc, please.

Cheers,
Comment 4 Rafael Oliveira Nóbrega CLA 2008-05-20 10:16:23 EDT
Created attachment 101042 [details]
mylyn/context/zip
Comment 5 Chris Aniszczyk CLA 2008-05-20 11:53:10 EDT
It's a start. I updated some of the javadoc and committed it.

By the way, I noticed we have org.eclipse.pde.internal.ds.core.IDSComponent.getImplementations()... I believe a component can only have one implementation.
Comment 6 Darin Wright CLA 2008-05-20 16:32:38 EDT
Marking as P2 since this shows up as a P1 against the Eclipse project (and since it's an incubator, it's not stop ship).
Comment 7 Rafael Oliveira Nóbrega CLA 2008-05-21 14:10:53 EDT
Created attachment 101329 [details]
IDSObject, IDSProperty and IDSProperties javadocs

Chris,

I guess IDSObject needs a more detailed review than IDSProperty and IDSProperties. :)

Cheers,
Comment 8 Chris Aniszczyk CLA 2008-05-21 14:15:38 EDT
nice! committed.
Comment 9 Rafael Oliveira Nóbrega CLA 2008-05-21 15:37:46 EDT
Created attachment 101355 [details]
IDSService, IDSProvide, IDSReference and IDSImplementation updates
Comment 10 Chris Aniszczyk CLA 2008-05-21 18:31:48 EDT
nice, I think that just leaves...

org.eclipse.pde.internal.ds.core.IDSConstants

also, do you think we can remove these methods on IDSModel?
	public abstract void setUnderlyingResource(IResource resource);
	public abstract void save();
	
What do you think?
Comment 11 Chris Aniszczyk CLA 2008-05-21 18:32:06 EDT
oops, changed the topic accidently
Comment 12 Rafael Oliveira Nóbrega CLA 2008-05-22 09:10:11 EDT
Hum, I guess we can remove them. :)

Chris,

I found a little problem in IDSReference getReferenceCardinality and setReferenceCardinality methods.

the "-" token was changed by "â??"

Cheers,
Comment 13 Chris Aniszczyk CLA 2008-05-22 09:25:17 EDT
Can you apply a patch? Is your project set as UTF-8?
Comment 14 Rafael Oliveira Nóbrega CLA 2008-05-22 09:57:46 EDT
yes it is, should I change to cp1252?
Comment 15 Chris Aniszczyk CLA 2008-05-22 10:37:22 EDT
no, it should remain UTF-8
Comment 16 Rafael Oliveira Nóbrega CLA 2008-05-22 10:45:09 EDT
Created attachment 101517 [details]
IDSReference updates
Comment 17 Rafael Oliveira Nóbrega CLA 2008-05-22 14:06:04 EDT
Created attachment 101572 [details]
IDSModel and IDSDocumentFactory javadocs
Comment 18 Rafael Oliveira Nóbrega CLA 2008-05-22 19:05:18 EDT
Created attachment 101655 [details]
javadocs for core.ds concrete classes  1/2
Comment 19 Rafael Oliveira Nóbrega CLA 2008-05-22 19:05:42 EDT
Created attachment 101656 [details]
javadocs for core.ds concrete classes  2/2
Comment 20 Chris Aniszczyk CLA 2008-05-22 22:45:10 EDT
done.

Thank you for your contributions on this Rafael, now we can focus on the fun stuff :)
Comment 21 Rafael Oliveira Nóbrega CLA 2008-05-23 08:34:28 EDT
Chris,

I guess you forgot to apply this patch:

Created an attachment (id=101517)
IDSReference updates

Cheers,