cleanup some API/javadoc. Add API changes for SBV support.
--- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java Wed May 20 15:36:03 2009 -0500
+++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/EpocEngineHelper.java Wed May 20 16:30:55 2009 -0500
@@ -2089,6 +2089,12 @@
return target;
}
+ /**
+ * Get the MD5 hash for a configuration if it is a true binary variation.
+ * @param config - The Carbide build configuration to check against
+ * @param mmpFullPath - The path to the MMP file that builds the binary
+ * @return A string of the MD5 hash. Returns an empty string if the configuration is not a binary variant or cannot be determined.
+ */
static public String getMD5HashForBinaryVariant(final ICarbideBuildConfiguration config, final IPath mmpFullPath){
return (String)EpocEnginePlugin.runWithMMPData(mmpFullPath,
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/api_Change_Notes.htm Wed May 20 15:36:03 2009 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/api_Change_Notes.htm Wed May 20 16:30:55 2009 -0500
@@ -65,14 +65,24 @@
<p>Since Carbide 2.1.0</p>
<ul>
<li>Added <em> com.nokia.carbide.cdt.builder.builder.CarbideCPPBuilder#getBuilderMakefileDir(ICarbideBuildConfiguration config)</em>.</li>
-</ul>
-
-<ul>
- <li>Added <em> com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext#getBuildVariationName( )</em>.</li>
-</ul>
-
-<ul>
- <li>Added <em> com.nokia.carbide.cdt.builder.EpocEngineHelper#isFeatureVariantMMP(IMMPData mmpData, IProject project)</em>.</li>
+ <li>Support was added for Symbian Binary Variation (SBV):</li>
+ <ul>
+ <li>Added <em> com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext#getBuildVariationName( )</em>.</li>
+ <li>Added <em> com.nokia.carbide.cdt.builder.EpocEngineHelper#hasFeatureVariantKeyword( ICarbideProjectInfo projectInfo, IPath relativeMMPPath )</em>.</li>
+ <li>Added <em> com.nokia.carbide.cdt.builder.EpocEngineHelper#getMD5HashForBinaryVariant( ICarbideBuildConfiguration config, IPath mmpFullPath)</em>.</li>
+ <li>Added <em>com.nokia.carbide.cpp.sdk.core.ISymbianSDK#getSBVCatalog( )</em>.</li>
+ <li>Added <em>com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext#getBuildVariationName( )</em>.</li>
+ <li>Added <em>com.nokia.carbide.cpp.sdk.core.ISymbianBuildContext#isSymbianBinaryVariation( )</em>.</li>
+ <li>Added <em>com.nokia.carbide.cpp.sdk.core.ISBVCatalog.</em> </li>
+ <li>Added <em>com.nokia.carbide.cpp.sdk.core.ISBVPlatfor</em>m.</li>
+ <li>Added EPOC Engine support for SBV in the following packages:
+ <ul>
+ <li><em>com.nokia.carbide.cpp.epoc.engine</em></li>
+ <li><em>com.nokia.carbide.cpp.epoc.engine.model</em></li>
+ <li><em>com.nokia.carbide.cpp.epoc.engine.model.sbv</em>.</li>
+ </ul>
+ </li>
+ </ul>
</ul>
<h3>Deprecated APIs</h3>
@@ -113,7 +123,7 @@
<p>Since Carbide 2.1</p>
<ul>
- <li><i>com.nokia.carbide.cdt.builder.getVariantTargetName(IMMPData mmpData, IPath target)</i></li>
+ <li><i>com.nokia.carbide.cdt.builder.EpocEngineHelper#getVariantTargetName(IMMPData mmpData, IPath target)</i></li>
</ul>
<h3>Removed APIs</h3>
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBVCatalog.java Wed May 20 15:36:03 2009 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBVCatalog.java Wed May 20 16:30:55 2009 -0500
@@ -17,6 +17,7 @@
/**
* This is a catalog of all the .VAR (Symbian Binary Variation) files detected for a given SDK.
*
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVCatalog {
/**
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBVPlatform.java Wed May 20 15:36:03 2009 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBVPlatform.java Wed May 20 16:30:55 2009 -0500
@@ -25,6 +25,8 @@
* Once a platform is available
* from a catalog, it is contained in a hierarchy of platforms, terminating at
* built-in platforms (like ARMV5).
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVPlatform {
/**
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.java Wed May 20 15:36:03 2009 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.java Wed May 20 16:30:55 2009 -0500
@@ -25,6 +25,7 @@
* from the configuration display string
* @see ICarbideBuildConfiguration
*
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISymbianBuildContext {
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDK.java Wed May 20 15:36:03 2009 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDK.java Wed May 20 16:30:55 2009 -0500
@@ -29,6 +29,8 @@
* - String value are empty ""
* - IPath and IFile objects are null
* - containers have zero size
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISymbianSDK {
--- a/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/ISBVViewRunnable.java Wed May 20 15:36:03 2009 -0500
+++ b/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/ISBVViewRunnable.java Wed May 20 16:30:55 2009 -0500
@@ -24,6 +24,7 @@
* Instantiate this interface and pass to EpocEnginePlugin#runWithSBVView()
* to encapsulate some of the bookkeeping of model/view handling.
*
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVViewRunnable extends IViewRunnable<ISBVModel, ISBVView> {
--- a/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVModel.java Wed May 20 15:36:03 2009 -0500
+++ b/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVModel.java Wed May 20 16:30:55 2009 -0500
@@ -22,6 +22,7 @@
/**
* This is the user interface to a Symbian Binary Variation (VAR) model.
*
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVModel extends IModel<ISBVView> {
--- a/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVOwnedModel.java Wed May 20 15:36:03 2009 -0500
+++ b/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVOwnedModel.java Wed May 20 16:30:55 2009 -0500
@@ -21,6 +21,8 @@
/**
* This is the owner interface to the SBV (Symbian Binary Variant) model.
+ *
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVOwnedModel extends ISBVModel, IOwnedModel<ISBVView> {
--- a/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVView.java Wed May 20 15:36:03 2009 -0500
+++ b/project/com.nokia.carbide.cpp.epoc.engine/src/com/nokia/carbide/cpp/epoc/engine/model/sbv/ISBVView.java Wed May 20 16:30:55 2009 -0500
@@ -26,7 +26,7 @@
* <p>
* Note: this view cannot be rewritten.
*
- *
+ * @noimplement This interface is not intended to be implemented by clients.
*/
public interface ISBVView extends IView<ISBVOwnedModel> {