Attachment 95491 Details for Bug 225506 – Patch adding Javadoc for FileDialogFactory

[patch] Patch adding Javadoc for FileDialogFactory

bug225506_FileDialogFactoryJavadoc.diff.txt (text/plain), 2.57 KB, created by Martin Oberhuber

on 2008-04-10 05:35:05 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Oberhuber

Created: 2008-04-10 05:35:05 EDT

Size: 2.57 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.rse.files.ui
>Index: src/org/eclipse/rse/files/ui/dialogs/FileDialogFactory.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.rse/plugins/org.eclipse.rse.files.ui/src/org/eclipse/rse/files/ui/dialogs/FileDialogFactory.java,v
>retrieving revision 1.1
>diff -u -r1.1 FileDialogFactory.java
>--- src/org/eclipse/rse/files/ui/dialogs/FileDialogFactory.java	10 Apr 2008 02:40:00 -0000	1.1
>+++ src/org/eclipse/rse/files/ui/dialogs/FileDialogFactory.java	10 Apr 2008 09:28:12 -0000
>@@ -1,11 +1,12 @@
> /*********************************************************************************
>  * Copyright (c) 2008 IBM Corporation. All rights reserved.
>  * This program and the accompanying materials are made available under the terms
>- * of the Eclipse Public License v1.0 which accompanies this distribution, and is 
>+ * of the Eclipse Public License v1.0 which accompanies this distribution, and is
>  * available at http://www.eclipse.org/legal/epl-v10.html
>- * 
>+ *
>  * Contributors:
>- * Xuan Chen (IBM) - [225506] initial contribution 
>+ * Xuan Chen (IBM) - [225506] initial contribution
>+ * Martin Oberhuber (Wind River) - [225506] Adding Javadoc
>  *********************************************************************************/
> package org.eclipse.rse.files.ui.dialogs;
> 
>@@ -13,19 +14,38 @@
> import org.eclipse.swt.widgets.Shell;
> 
> /**
>- * @author xuanchen
>+ * Utility class with factory methods for creating some RSE Standard Dialogs,
>+ * for working with remote files.
>  *
>+ * @noextend This class is not intended to be subclassed by clients.
>+ * @noinstantiate This class is not intended to be instantiated by clients.
>+ * @since org.eclipse.rse.files.ui 3.0
>  */
> public class FileDialogFactory {
>-	
>+
>+	/**
>+	 * Create an ISaveAsDialog instance with the given title, initialized for
>+	 * selecting a file to save to.
>+	 *
>+	 * @param shell parent shell for the dialog
>+	 * @param title title for the dialog
>+	 * @return New ISaveAsDialog instance
>+	 */
> 	public static ISaveAsDialog makeSaveAsDialog(Shell shell, String title)
> 	{
> 		return new SaveAsDialog(shell, title);
> 	}
>-	
>+
>+	/**
>+	 * Create an ISaveAsDialog instance, initialized for selecting a folder to
>+	 * save to. The dialog title will be a standard title ("Browse for Folder").
>+	 *
>+	 * @param shell parent shell for the dialog
>+	 * @return new ISaveAsDialog instance
>+	 */
> 	public static ISaveAsDialog makeSaveAsDialog(Shell shell)
> 	{
> 		return new SaveAsDialog(shell);
>-	}	
>+	}
> 
> }

Actions: View | Diff

Attachments on bug 225506: 94779 | 94792 | 94827 | 94875 | 95073 | 95075 | 95076 | 95491