Changeset 6382 for trunk/gli/src/org/greenstone/gatherer/gui/AboutDialog.java

Timestamp:

2004-01-09T14:48:06+13:00 (20 years ago)

Author:

jmt12

Message:

Finished commenting to 2.41 final standard

File:

• trunk/gli/src/org/greenstone/gatherer/gui/AboutDialog.java (modified) (4 diffs)

trunk/gli/src/org/greenstone/gatherer/gui/AboutDialog.java

@@ -2 +2 @@
  *#########################################################################
  *
- * A component of the Gatherer application, part of the Greenstone digital
- * library suite from the New Zealand Digital Library Project at the
- * University of Waikato, New Zealand.
+ * A component of the Greenstone Librarian Interface (GLI) application, 
+ * part of the Greenstone digital library software suite from the New 
+ * Zealand Digital Library Project at the University of Waikato, 
+ * New Zealand.
  *
- * <BR><BR>
+ * Author: John Thompson
+ *         Greenstone Project, New Zealand Digital Library
+ *         University of Waikato
+ *         http://www.nzdl.org
  *
- * Author: John Thompson, Greenstone Digital Library, University of Waikato
- *
- * <BR><BR>
- *
- * Copyright (C) 1999 New Zealand Digital Library Project
- *
- * <BR><BR>
+ * Copyright (C) 2004 New Zealand Digital Library, University of Waikato
  *
  * This program is free software; you can redistribute it and/or modify
@@ -21 +19 @@
  * (at your option) any later version.
  *
- * <BR><BR>
- *
  * This program is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
- *
- * <BR><BR>
  *
  * You should have received a copy of the GNU General Public License
@@ -45 +39 @@
 import org.greenstone.gatherer.util.Utility;
 
-/**
- * @author John Thompson, Greenstone Digital Library, University of Waikato
- * @version 2.3c
+/** Generates a pretty about dialog which not only thanks those for their contributions but also meets our legal requirements if we wish to ship the JVM with GLI.
+ * @author John Thompson, Greenstone Project, New Zealand Digital Library, University of Waikato
+ * @version 2.41 final
  */
-
 // RICOH SOURCE CODE PUBLIC LICENSE - http://www.risource.org/RPL/RPL-1.0A.shtml
 public class AboutDialog
     extends JDialog {
+    /** The default size of the about dialog. */
+    static final private Dimension SIZE = new Dimension(600, 325);
+    /** The size of the GLI icon to display on dialog. */
+    static final private int ICON_SIZE = 65;
+    /** A reference to ourself so that our inner classes can dismiss us. */
     private AboutDialog self;
+    /** The button used for dismissing the about dialog. */
     private JButton close_button;
-
-    static final private Dimension SIZE = new Dimension(600, 325);
-    static final private int ICON_SIZE = 65;
-
+    /** The constructor not only builds, but displays the about dialog. This method doesn't return until the dialog is dismissed.
+     * @param parent the JFrame which owns this dialog for use in centering the dialog
+     * @see org.greenstone.gatherer.Dictionary#get
+     * @see org.greenstone.gatherer.Dictionary#setBoth
+     * @see org.greenstone.gatherer.Dictionary#setText
+     * @see org.greenstone.gatherer.gui.AboutDialog.CloseButtonListener
+     * @see org.greenstone.gatherer.gui.GLIButton
+     * @see org.greenstone.gatherer.util.Utility#getImage
+     * @see org.greenstone.gatherer.util.Utility#PROGRAM_NAME
+     * @see org.greenstone.gatherer.util.Utility#PROGRAM_VERSION
+     */
     public AboutDialog(JFrame parent) {
     super(parent, Dictionary.get("AboutDialog.Title"), true);
@@ -154 +160 @@
     show();
     }
-
+    /** Listens for actions upon the close button, and when detected closes the dialog. */
     private class CloseButtonListener
     implements ActionListener {
+    /** Called whenever an action occurs on the close button, thus asking the dialog to close.
+     * @param event an ActionEvent containing information about the button press
+     */
     public void actionPerformed(ActionEvent event) {
         self.hide();