Community
Participate
Working Groups
The whole DS core plug-in needs to be well javadoc'd, especially the interfaces.
upping priority
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 :)
Created attachment 101041 [details] IDSComponent javadoc Chris, could you give me a feedback about this first javadoc, please. Cheers,
Created attachment 101042 [details] mylyn/context/zip
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.
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).
Created attachment 101329 [details] IDSObject, IDSProperty and IDSProperties javadocs Chris, I guess IDSObject needs a more detailed review than IDSProperty and IDSProperties. :) Cheers,
nice! committed.
Created attachment 101355 [details] IDSService, IDSProvide, IDSReference and IDSImplementation updates
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?
oops, changed the topic accidently
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,
Can you apply a patch? Is your project set as UTF-8?
yes it is, should I change to cp1252?
no, it should remain UTF-8
Created attachment 101517 [details] IDSReference updates
Created attachment 101572 [details] IDSModel and IDSDocumentFactory javadocs
Created attachment 101655 [details] javadocs for core.ds concrete classes 1/2
Created attachment 101656 [details] javadocs for core.ds concrete classes 2/2
done. Thank you for your contributions on this Rafael, now we can focus on the fun stuff :)
Chris, I guess you forgot to apply this patch: Created an attachment (id=101517) IDSReference updates Cheers,