add @noimplement to some APIs C3_BUILDER_WORK
authortimkelly
Mon, 02 Aug 2010 15:09:54 -0500
branchC3_BUILDER_WORK
changeset 1738 776775d1ff38
parent 1737 ba17d4654040
child 1739 5f659a59d04a
add @noimplement to some APIs
carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/api_Change_Notes.htm
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java
core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java
--- a/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/api_Change_Notes.htm	Mon Aug 02 11:10:33 2010 -0500
+++ b/carbidesdk/com.nokia.carbide.cpp.sdk.doc.user/html/reference/api_Change_Notes.htm	Mon Aug 02 15:09:54 2010 -0500
@@ -117,7 +117,7 @@
 	<li><i>ISymbianSDK</i></li>
 	<ul>
 		<li>added <i>getSupportedFeatures()</i> - see <i>com.nokia.carbide.cpp.sdk.core#ISymbianSDKFeatures</i> for supported feature constants.</li>
-		<li>added <i>ISDKBuildInfo getBuildInfo(String builderId)</i> - This is used to get the base data (ISymbianBuildContext) for a build configuration, depending on the builder you are using (e.g. abld versus sbsv2). See com.nokia.carbide.cpp.sdk.core#ISDKBuildInfo </li>
+		<li>added <i>ISDKBuildInfo getBuildInfo(String builderId)</i> - This is used to get the base data (ISymbianBuildContext) for a build configuration, depending on the builder you are using (e.g. abld versus sbsv2). See also <i>com.nokia.carbide.cpp.sdk.core#ISDKBuildInfo</i> </li>
 	</ul>
 	
 	<li><i>com.nokia.carbide.cpp.sdk.core#ISDKBuildInfo</i> was added.</li>
@@ -142,6 +142,9 @@
 	</ul>
 
 	<li><i>ISymbianBuildContext</i> - This interface is no longer implemented by ICarbideBuildConfiguration. Rather, it is now an abstracted interface for builders to provide base build data for an <i>ICarbideBuildConfiguration</i> instance</li>
+	<p/>
+	<ul>Due to this change, methods that take ISymbiabBuildContext as a parameter may have been using the ICarbideBuildConfiguraiton interface. For example, in <i>com.nokia.carbide.cdt.builder#DefaultMMPViewConfiguration.</i>
+	 For these calls, simply add <i>.getBuildContext()</i> to the <i>ICarbideBuildConfiguration</i> instance to explicitly pass the <i>ISymbianBuildContext</i>.</ul>
 
 	<li><i>IConnectionsManager</i> was updated to indicate it is not intended to be implemented by clients.
 	<li>Added several new methods to support automated connection/device discovery agents and default connections.</li>
@@ -235,6 +238,12 @@
 <p>Since Carbide 3.0</p>
 <ul>
   <li><i>com.nokia.carbide.cpp.sdk.core#ISymbianSDK</i> removed several methods. Please refer to the source code.</li>
+   <p/>
+   <ul>
+   		<li><i>getFilteredBuildConfigurations()</i> has been removed. Please use <i> </i> instead.  </li>
+   		<li><i>getSDKVersion()</i> has been removed. Users should not use SDK and OS version any longer but use <i>ISymbiabSDK#getBuildInfo(ISymbianBuilderID."BUILDERID").getFilteredBuildConfigurations()</i> instead.</li>
+   </ul>
+   
    <li><i>ICarbideBuildConfiguration</i> no longer implements <i>ISymbiabBuildContext</i>. You will need to use the ISymbianBuildContext wrapper methods to access that interface now.</li>
 </ul>
 
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java	Mon Aug 02 11:10:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java	Mon Aug 02 15:09:54 2010 -0500
@@ -4,6 +4,7 @@
  * Build Context specific information for the SBS/Raptor Symbian Builder.
  * @see ICarbideBuildConfigation
  * @since 3.0
+ * @deprecated - ABLD is dead.
  *
  */
 public interface ISBSv1BuildContext extends ISymbianBuildContext {
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java	Mon Aug 02 11:10:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java	Mon Aug 02 15:09:54 2010 -0500
@@ -20,6 +20,7 @@
 /**
  * Interface for build related information of a Symbian SDK.
  * @since 3.0
+ * @noimplement This interface is not intended to be implemented by clients.
  */
 public interface ISDKBuildInfo {
 
--- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java	Mon Aug 02 11:10:33 2010 -0500
+++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java	Mon Aug 02 15:09:54 2010 -0500
@@ -16,14 +16,14 @@
 /**
  * A collection of Symbian SDK feature IDs.
  * @since 3.0
- *
+ * @noimplement This interface is not intended to be implemented by clients.
  */
 public interface ISymbianSDKFeatures {
 
 	public static final String IS_QT_INSTALLED = "isQtInstalled";
 	public static final String IS_AVKON_SUPPORTED = "isAvkonSupported";
 	public static final String IS_WINSCW_UREL_SUPPORTED = "isWINSCWURELSupported";
-	public static final String IS_EKA1 = "isEAK1";
+	public static final String IS_EKA1 = "isEKA1";
 	public static final String IS_EKA2 = "isEKA2";
 	public static final String IS_FROM_DEVICES_XML = "isFromDevicesXml";