# HG changeset patch # User timkelly # Date 1280354851 18000 # Node ID 4abaef518a1fb5aebc2cdb0311eb2c5664e285c0 # Parent ff0db4bbc1890f0f6779be90b5a1eb43b473fe22 put @since 3.0 on public APIs, where needed diff -r ff0db4bbc189 -r 4abaef518a1f builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java --- a/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java Wed Jul 28 16:48:09 2010 -0500 +++ b/builder/com.nokia.carbide.cdt.builder/src/com/nokia/carbide/cdt/builder/project/ICarbideBuildConfiguration.java Wed Jul 28 17:07:31 2010 -0500 @@ -126,51 +126,45 @@ /** * Retrieve the build context specific info. - * @return + * @return ISymbianBuildContext + * @since 3.0 */ ISymbianBuildContext getBuildContext(); - /** ISymbianBuildContext wrapper */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ String getDisplayString(); - /** ISymbianBuildContext wrapper */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ ISymbianSDK getSDK(); - /** ISymbianBuildContext wrapper */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ String getPlatformString(); - /** ISymbianBuildContext wrapper */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ String getTargetString(); - /** - * Get the compiler prefix file. This is an ISymbianBuildContext wrapper. - * @return The path to the compiler's prefix file. May be null if none. - */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ public IPath getCompilerPrefixFile(); - /** - * Get the macros associated with preprocessing CPP source files. This is an ISymbianBuildContext wrapper. - * @return the list of IDefine macros - */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ public List getCompilerMacros(); - /** - * Get the macros discovered from preprocessing the SDK prefix file for the configuration. This is an ISymbianBuildContext wrapper. - * @return the list of IDefine macros - */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ public List getVariantHRHDefines(); - /** - * Get the list of include files included in the variant HRH SDK preinclude file - * This is used to check dependencies on all SDK/Configuration includes. This is an ISymbianBuildContext wrapper. - * @return - */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ public List getPrefixFileIncludes(); - /** - * Get the variant portion of a build configuration name. May be an empty string. This is an ISymbianBuildContext wrapper. - * @return - */ + /** ISymbianBuildContext wrapper + * @since 3.0 */ public String getBuildVariationName(); /** @@ -182,6 +176,7 @@ /** * Check that at least one MMP in the project configuration has stdcpp support keyword * @return + * @since 3.0 */ public boolean hasSTDCPPSupport(); diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/sbsv2/SBSv2MinimumVersionException.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/sbsv2/SBSv2MinimumVersionException.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/internal/api/sdk/sbsv2/SBSv2MinimumVersionException.java Wed Jul 28 17:07:31 2010 -0500 @@ -15,6 +15,7 @@ /** * Exception thrown in case something fails when trying * find out facts about current SDK/Platform environment tools. + * @since 3.0 */ public class SBSv2MinimumVersionException extends Exception { diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv1BuildContext.java Wed Jul 28 17:07:31 2010 -0500 @@ -1,5 +1,11 @@ package com.nokia.carbide.cpp.sdk.core; +/** + * Build Context specific information for the SBS/Raptor Symbian Builder. + * @see ICarbideBuildConfigation + * @since 3.0 + * + */ public interface ISBSv1BuildContext extends ISymbianBuildContext { /** diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2BuildContext.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2BuildContext.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2BuildContext.java Wed Jul 28 17:07:31 2010 -0500 @@ -4,7 +4,12 @@ import org.eclipse.core.runtime.IPath; - +/** + * Build Context specific information for the SBS/Raptor Symbian Builder. + * @see ICarbideBuildConfigation + * @since 3.0 + * + */ public interface ISBSv2BuildContext extends ISymbianBuildContext { public static final String BUILDER_ID = "com.nokia.carbide.builder.raptor"; diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2ConfigQueryData.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2ConfigQueryData.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISBSv2ConfigQueryData.java Wed Jul 28 17:07:31 2010 -0500 @@ -4,6 +4,10 @@ import java.util.List; import java.util.Map; +/** + * Interface to interact directly with results for Raptor configuration query data (--query=config{<config>]) + * @since 3.0 + */ public interface ISBSv2ConfigQueryData extends Serializable { public String getAlias(); public String getBuildPrefix(); diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISDKBuildInfo.java Wed Jul 28 17:07:31 2010 -0500 @@ -19,7 +19,7 @@ /** * Interface for build related information of a Symbian SDK. - * + * @since 3.0 */ public interface ISDKBuildInfo { diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuildContext.java Wed Jul 28 17:07:31 2010 -0500 @@ -30,7 +30,7 @@ public interface ISymbianBuildContext { /** - * DEFAULT suffix to use for components that are specified as variant, but don't buid as variants. For example, plain ARMV5, when specified as + * DEFAULT suffix to use for components that are specified as variant, but don't build as variants. For example, plain ARMV5, when specified as * as a FEATUREVARIANT, will build as ARMV5.DEFAULT * @since 2.0 */ diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianBuilderID.java Wed Jul 28 17:07:31 2010 -0500 @@ -15,7 +15,7 @@ /** * A collection of Symbian builder IDs. - * + * @since 3.0 */ public interface ISymbianBuilderID { diff -r ff0db4bbc189 -r 4abaef518a1f core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java --- a/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java Wed Jul 28 16:48:09 2010 -0500 +++ b/core/com.nokia.carbide.cpp.sdk.core/src/com/nokia/carbide/cpp/sdk/core/ISymbianSDKFeatures.java Wed Jul 28 17:07:31 2010 -0500 @@ -15,6 +15,7 @@ /** * A collection of Symbian SDK feature IDs. + * @since 3.0 * */ public interface ISymbianSDKFeatures {