Bug 231399

Comment 1 Chris Aniszczyk 2008-05-12 21:40:38 EDT

upping priority

Comment 2 Chris Aniszczyk 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 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 2008-05-20 10:16:23 EDT

Created attachment 101042 [details]
mylyn/context/zip

Comment 5 Chris Aniszczyk 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 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 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 2008-05-21 14:15:38 EDT

nice! committed.

Comment 9 Rafael Oliveira Nóbrega 2008-05-21 15:37:46 EDT

Created attachment 101355 [details]
IDSService, IDSProvide, IDSReference and IDSImplementation updates

Comment 10 Chris Aniszczyk 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 2008-05-21 18:32:06 EDT

oops, changed the topic accidently

Comment 12 Rafael Oliveira Nóbrega 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 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 2008-05-22 09:57:46 EDT

yes it is, should I change to cp1252?

Comment 15 Chris Aniszczyk 2008-05-22 10:37:22 EDT

no, it should remain UTF-8

Comment 16 Rafael Oliveira Nóbrega 2008-05-22 10:45:09 EDT

Created attachment 101517 [details]
IDSReference updates

Comment 17 Rafael Oliveira Nóbrega 2008-05-22 14:06:04 EDT

Created attachment 101572 [details]
IDSModel and IDSDocumentFactory javadocs

Comment 18 Rafael Oliveira Nóbrega 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 2008-05-22 19:05:42 EDT

Created attachment 101656 [details]
javadocs for core.ds concrete classes  2/2

Comment 20 Chris Aniszczyk 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 2008-05-23 08:34:28 EDT

Chris,

I guess you forgot to apply this patch:

Created an attachment (id=101517)
IDSReference updates

Cheers,