Skip to content

Commit ef1d935

Browse files
committed
Better scaladoc for FileChooser
1 parent af2ede6 commit ef1d935

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

src/main/scala/scala/swing/FileChooser.scala

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ object FileChooser {
3737
/**
3838
* Used to open file dialogs.
3939
*
40-
* @see [[javax.swing.JFileChooser]]
40+
* @see [[http://docs.oracle.com/javase/7/docs/api/javax/swing/JFileChooser.html javax.swing.JFileChooser]]
4141
*/
4242
class FileChooser(dir: File) {
4343
import scala.swing.FileChooser._
@@ -48,24 +48,24 @@ class FileChooser(dir: File) {
4848
import scala.swing.Swing._
4949

5050
/**
51-
* Display a dialog box to select a file.
52-
* @param over Parent container - Component, Frame or Dialog
53-
* @return Status of how the dialog was closed.
51+
* Display a dialog box to select an "Open File" file.
52+
* @param over Parent container - [[scala.swing.Component Component]], [[scala.swing.Frame Frame]] or [[scala.swing.Dialog Dialog]]
53+
* @return a [[scala.swing.FileChooser.Result Result]] value based how dialog was closed.
5454
*/
5555
def showOpenDialog(over: PeerContainer): Result.Value = Result(peer.showOpenDialog(nullPeer(over)))
5656

5757
/**
58-
* Display a dialog box to select a file.
59-
* @param over Parent container - Component, Frame or Dialog
60-
* @return Parent container - Component, Frame or Dialog
58+
* Display a dialog box to select a "Save File" file.
59+
* @param over Parent container - [[scala.swing.Component Component]], [[scala.swing.Frame Frame]] or [[scala.swing.Dialog Dialog]]
60+
* @return a [[scala.swing.FileChooser.Result Result]] value based how dialog was closed.
6161
*/
6262
def showSaveDialog(over: PeerContainer): Result.Value = Result(peer.showSaveDialog(nullPeer(over)))
6363

6464
/**
6565
* Display a dialog box to select a file.
66-
* @param over Parent container - Component, Frame or Dialog
67-
* @param approveText text for the 'ok' button
68-
* @return Parent container - Component, Frame or Dialog
66+
* @param over Parent container - [[scala.swing.Component Component]], [[scala.swing.Frame Frame]] or [[scala.swing.Dialog Dialog]]
67+
* @param approveText Text for the 'ok' or 'approve' button.
68+
* @return a [[scala.swing.FileChooser.Result Result]] value based how dialog was closed.
6969
*/
7070
def showDialog(over: PeerContainer, approveText: String): Result.Value = Result(peer.showDialog(nullPeer(over), approveText))
7171

0 commit comments

Comments
 (0)