Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[dsdp-dd-dev] IP-XACT editor package naming.

People,
 
Now that IP-XACT 1.4 has been released, I am starting to think about checking in the IP-XACT 1.4 version of the editor.
 
I have just been reading the Eclipse naming conventions (http://wiki.eclipse.org/Naming_Conventions) and I think that, since I don't export any public APIs, I should be renaming all the packages in the IP-XACT editor plugins as internal packages before checking them in. My understanding from this page is that the subproject here is "org.eclipse.dsdp.dd", and that as such the packages should be named "org.eclipse.dsdp.dd.internal...", so, for example, the editor core document package would become "org.eclipse.dsdp.dd.internal.ipxact.editor.core.document". Two questions:
  1. Do I need to do this renaming?
  2. Am I putting the "internal" in the right place in the names?
- Anthony
 
P.S. I am also starting to think about what APIs the editor could usefully export. It is obviously too late to make any of these official APIs for Ganymede, but there seems to be a convention that preliminary versions of APIs can be exported with a package name including "internal.provisional.". Is this your understanding, and if so would there be any objection to including some such APIs in the editor?
 
- Anthony
 

--------------------------

Anthony Berent

ARM Ltd

+44 1223 400763

 

--

IMPORTANT NOTICE: The contents of this email and any attachments are confidential and may also be privileged. If you are not the intended recipient, please notify the sender immediately and do not disclose the contents to any other person, use it for any purpose, or store or copy the information in any medium.  Thank you.


Back to the top