8000425: FileDialog documentation should be enhanced
authorbagiras
Tue, 08 Oct 2013 16:04:12 +0400
changeset 20462 1b06fa1bb364
parent 20461 f9eb0540693c
child 20463 ed2ea3722c31
8000425: FileDialog documentation should be enhanced Reviewed-by: serb, anthony
jdk/src/share/classes/java/awt/FileDialog.java
--- a/jdk/src/share/classes/java/awt/FileDialog.java	Tue Oct 08 15:54:43 2013 +0400
+++ b/jdk/src/share/classes/java/awt/FileDialog.java	Tue Oct 08 16:04:12 2013 +0400
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995, 2010, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1995, 2013, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -457,9 +457,16 @@
      * specified file. This file becomes the default file if it is set
      * before the file dialog window is first shown.
      * <p>
+     * When the dialog is shown, the specified file is selected. The kind of
+     * selection depends on the file existence, the dialog type, and the native
+     * platform. E.g., the file could be highlighted in the file list, or a
+     * file name editbox could be populated with the file name.
+     * <p>
+     * This method accepts either a full file path, or a file name with an
+     * extension if used together with the {@code setDirectory} method.
+     * <p>
      * Specifying "" as the file is exactly equivalent to specifying
-     * <code>null</code>
-     * as the file.
+     * {@code null} as the file.
      *
      * @param    file   the file being set
      * @see      #getFile