# HG changeset patch # User stechong # Date 1247069248 18000 # Node ID 26cc9825bb335b67c559ced0311972b16df2f22f # Parent 539b1b65d45f85faed31b0ab0139eb941c20c704 Added missing @since tags; fix for Bug 9220. diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/DialogSettingsPersistedStorage.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/DialogSettingsPersistedStorage.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/DialogSettingsPersistedStorage.java Wed Jul 08 11:07:28 2009 -0500 @@ -23,6 +23,7 @@ /** * This class is a default implementation of {@link IPersistedSettingStorage} that * uses IDialogSettings to store its contents as strings. + * @since 2.1 * */ public class DialogSettingsPersistedStorage implements diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplate.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplate.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplate.java Wed Jul 08 11:07:28 2009 -0500 @@ -26,6 +26,7 @@ /** * This interface, available through {@link ITemplate#getLoadedTemplate()}, * provides the runtime model for template XML and a way to create its UI. + * @since 2.1 */ public interface ILoadedTemplate { /** diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplateUI.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplateUI.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ILoadedTemplateUI.java Wed Jul 08 11:07:28 2009 -0500 @@ -34,6 +34,7 @@ *

* The UI is created such that all fields have default valus, unless {@link #loadSettings(IPersistedSettingStorage)} * is called to initialize from persisted storage. + * @since 2.1 * */ public interface ILoadedTemplateUI { diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/IPersistedSettingStorage.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/IPersistedSettingStorage.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/IPersistedSettingStorage.java Wed Jul 08 11:07:28 2009 -0500 @@ -22,6 +22,7 @@ * This interface is used in {@link ILoadedTemplate#createLoadedTemplateUI()} and * {@link ILoadedTemplateUI#persistValues(IPersistedSettingStorage)} to read and write * the persisted settings to a client-implemented store. + * @since 2.1 * */ public interface IPersistedSettingStorage { diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ITemplate.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ITemplate.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/template/engine/ITemplate.java Wed Jul 08 11:07:28 2009 -0500 @@ -58,12 +58,14 @@ * The wizardId attribute for this template. * * @return identifier for an Eclipse org.eclipse.ui.newWizards extension + * @since 2.1 */ String getWizardId(); /** * Get the name attribute for this template. If it is not defined, * read it from the 'label' in template XML. + * @since 2.1 */ String getDisplayName(); @@ -71,6 +73,7 @@ * The groupLabel attribute for this template, used to categorize templates. * * @return the string or unlocalized key for the group label. + * @since 2.1 */ String getGroupLabel(); @@ -79,12 +82,14 @@ * of this string is up to the specific instanceof TemplateWizard. * * @return the string used for filtering + * @since 2.1 */ String getFilterArguments(); /** * Get metadata for the template from the extension point definition. * @return the map of key-value pairs + * @since 2.1 */ Map getExtensionMetadata(); @@ -107,12 +112,14 @@ * return the entry for the current language. Otherwise, return the text itself. * @param text * @return original text or localized string + * @since 2.1 */ public String getLocalizedString(String text); /** * Get the image descriptor for the template * @return {@link ImageDescriptor}, never null + * @since 2.1 */ public ImageDescriptor getImageDescriptor(); @@ -120,11 +127,13 @@ * Get the loaded template information, loading the XML into memory if necessary. * @return ILoadedTemplate * @throws CoreException if template.xml could not be loaded + * @since 2.1 */ ILoadedTemplate getLoadedTemplate() throws CoreException; /** * Reset a template for use by a new wizard. + * @since 2.1 */ void reset(); } diff -r 539b1b65d45f -r 26cc9825bb33 core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/templatewizard/processes/CopyFiles.java --- a/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/templatewizard/processes/CopyFiles.java Mon Jul 06 14:59:19 2009 -0500 +++ b/core/com.nokia.carbide.templatewizard/src/com/nokia/carbide/templatewizard/processes/CopyFiles.java Wed Jul 08 11:07:28 2009 -0500 @@ -49,6 +49,9 @@ protected static final String LOWER_SUFFIX = "$lower"; //$NON-NLS-1$ protected static final String TITLE_SUFFIX = "$title"; //$NON-NLS-1$ protected static final String TITLELOWER_SUFFIX = "$titlelower"; //$NON-NLS-1$ + /** + * @since 2.1 + */ protected static final String C_ESCAPED_SUFFIX = "$c_escaped"; //$NON-NLS-1$ protected static final String SOURCE_PATH_ATTRIBUTE = "sourcePath"; //$NON-NLS-1$ protected static final String TARGET_PATH_ATTRIBUTE = "targetPath"; //$NON-NLS-1$