From: lhauch Date: Sat, 29 Jul 2006 04:39:01 +0000 (+0000) Subject: Added some additional comments in the files, as well as fixed some of them. X-Git-Tag: edk2-stable201903~24723 X-Git-Url: https://git.proxmox.com/?p=mirror_edk2.git;a=commitdiff_plain;h=9e857952dbebe1fcadb4efeee8ca338c1123bd13 Added some additional comments in the files, as well as fixed some of them. git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@1149 6f19259b-4bc3-4df7-8a09-765794883524 --- diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/BootModesDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/BootModesDlg.java index 937b8b6361..2e637eb1ee 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/BootModesDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/BootModesDlg.java @@ -42,10 +42,9 @@ import org.tianocore.frameworkwizard.common.ui.StarLabel; import org.tianocore.frameworkwizard.module.Identifications.BootModes.BootModesIdentification; /** - * The class is used to create, update BootModes of MSA/MBD file It extends - * IDialog - * - * + * The class is used to create, update BootModes of MSA/MBD file + * + * It extends IDialog * */ public class BootModesDlg extends IDialog { @@ -59,7 +58,7 @@ public class BootModesDlg extends IDialog { // Define class members // private JPanel jContentPane = null; -private JLabel jLabelTest = null; + private JLabel jLabelBootModeName = null; private JComboBox jComboBoxBootModeName = null; diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/DataHubsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/DataHubsDlg.java index b5238d9707..d22e80ceb7 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/DataHubsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/DataHubsDlg.java @@ -42,10 +42,9 @@ import org.tianocore.frameworkwizard.common.ui.StarLabel; import org.tianocore.frameworkwizard.module.Identifications.DataHubs.DataHubsIdentification; /** - * The class is used to create, update DataHub of MSA/MBD file It extends - * IInternalFrame - * + * The class is used to create, update DataHub of the MSA file * + * It extends IDialog * */ public class DataHubsDlg extends IDialog { diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/EventsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/EventsDlg.java index 624fae71df..71af9edaf9 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/EventsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/EventsDlg.java @@ -121,9 +121,9 @@ public class EventsDlg extends IDialog { jComboBoxEventsType.setBounds(new java.awt.Rectangle(168, 12, 320, 20)); jComboBoxEventsType.setPreferredSize(new java.awt.Dimension(320, 20)); jComboBoxEventsType - .setToolTipText("Select CreateEvents if the Module has an event that is waiting to be signaled.
" - + "Select SignalEvents if the Module will signal all events in an event group.
" - + "NOTE: Signal events are named by GUID."); + .setToolTipText("Select CreateEvents if the Module has an event that is waiting to be signaled.
" + + "Select SignalEvents if the Module will signal all events in an event group.
" + + "NOTE: Signal events are named by GUID."); } return jComboBoxEventsType; } @@ -172,15 +172,15 @@ public class EventsDlg extends IDialog { jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 87, 320, 20)); jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20)); jComboBoxUsage - .setToolTipText("" - + "" - + "" - + "" - + "" - + "" - + "
Create Events
ALWAYS_CONSUMEDModule registers a notification function and REQUIRES that it be
" - + "executed for the module to fully function.
SOMETIMES_CONSUMEDModule registers a notification function and calls the function
" - + "when it is signaled
Signal Events
ALWAYS_PRODUCEDModule will Always signal the event
SOMETIMES_PRODUCEDModule will sometimes signal the event
"); + .setToolTipText("" + + "" + + "" + + "" + + "" + + "" + + "
Create Events
ALWAYS_CONSUMEDModule registers a notification function and REQUIRES that it be
" + + "executed for the module to fully function.
SOMETIMES_CONSUMEDModule registers a notification function and calls the function
" + + "when it is signaled
Signal Events
ALWAYS_PRODUCEDModule will Always signal the event
SOMETIMES_PRODUCEDModule will sometimes signal the event
"); } return jComboBoxUsage; } diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/ExternsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/ExternsDlg.java index 80ff5a2367..68bfec2cc1 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/ExternsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/ExternsDlg.java @@ -37,12 +37,11 @@ import org.tianocore.frameworkwizard.common.ui.IFrame; import org.tianocore.frameworkwizard.module.Identifications.Externs.ExternsIdentification; /** - The class is used to create, update Externs section of the MSA file - It extends IDialog - - - - **/ + * The class is used to create, update Externs section of the MSA file + * + * It extends IDialog + * + */ public class ExternsDlg extends IDialog implements ItemListener { /// diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.java index a3c4b96fdc..cec910d091 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HiiPackagesDlg.java @@ -1,6 +1,6 @@ /** @file - The file is used to create, update Hii Packages section of the MSA file + The file is used to create, update Hii Packages section of the MSA file Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HobsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HobsDlg.java index d46958be1b..bb28db42e7 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HobsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/HobsDlg.java @@ -1,6 +1,6 @@ /** @file - The file is used to create, update Hob of MSA/MBD file + The file is used to create, update Hob section of the MSA file Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials @@ -38,7 +38,9 @@ import org.tianocore.frameworkwizard.module.Identifications.Hobs.HobsIdentificat import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update Hob of the MSA file It extends JDialog + * The class is used to create, update Hob of the MSA file + * + * It extends IDialog * */ public class HobsDlg extends IDialog { diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/LibraryClassDefsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/LibraryClassDefsDlg.java index 8b5dfd980b..8ac87003d3 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/LibraryClassDefsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/LibraryClassDefsDlg.java @@ -39,11 +39,11 @@ import org.tianocore.frameworkwizard.module.Identifications.LibraryClass.Library import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update Library Class Definition of MSA/MBD file + * The class is used to create, update Library Class Definition section of the MSA file * * It extends IDialog * - **/ + */ public class LibraryClassDefsDlg extends IDialog { /// diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PCDsDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PCDsDlg.java index 9e0f120a19..c22f1f03c5 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PCDsDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PCDsDlg.java @@ -1,6 +1,6 @@ /** @file - The file is used to create, update PCD of MSA/MBD file + The file is used to create, update PcdCode section of the MSA file Copyright (c) 2006, Intel Corporation All rights reserved. This program and the accompanying materials @@ -41,8 +41,9 @@ import org.tianocore.frameworkwizard.module.Identifications.PcdCoded.PcdVector; import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update PCD of MSA/MBD file It extends - * IInternalFrame + * The class is used to create, update PcdCoded section of the MSA file + * + * It extends IDialog * */ public class PCDsDlg extends IDialog implements ItemListener { @@ -98,7 +99,7 @@ public class PCDsDlg extends IDialog implements ItemListener { private JButton jButtonCancel = null; private JScrollPane jScrollPaneHelpText = null; - + private JLabel jLabelUsage = null; private JComboBox jComboBoxUsage = null; @@ -107,7 +108,7 @@ public class PCDsDlg extends IDialog implements ItemListener { // Not used by UI // private PcdCodedIdentification id = null; - + private EnumerationData ed = new EnumerationData(); private WorkspaceTools wt = new WorkspaceTools(); diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.java index ec122e6c97..2c7a355cc3 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PackageDepDlg.java @@ -40,7 +40,7 @@ import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** * The class is used to create, update Package Dependencies section of the MSA file * - * It extends * IDialog + * It extends IDialog * */ public class PackageDepDlg extends IDialog implements ItemListener { @@ -134,11 +134,11 @@ public class PackageDepDlg extends IDialog implements ItemListener { jTextFieldPackageVersion.setBounds(new java.awt.Rectangle(168, 37, 320, 20)); jTextFieldPackageVersion.setPreferredSize(new java.awt.Dimension(320, 20)); jTextFieldPackageVersion - .setToolTipText("If this module depends on a specific version of a package,
" - + "enter the package version here.
" - + "If the module can use the latest version
" - + "that does not break backward compatibility,
" - + "leave this field blank"); + .setToolTipText("If this module depends on a specific version of a package,
" + + "enter the package version here.
" + + "If the module can use the latest version
" + + "that does not break backward compatibility,
" + + "leave this field blank"); } return jTextFieldPackageVersion; } diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java index 2a2d2d399f..5c1fb9826b 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/PpisDlg.java @@ -40,8 +40,9 @@ import org.tianocore.frameworkwizard.module.Identifications.Ppis.PpisIdentificat import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update Ppi of MSA/MBD file It extends - * IInternalFrame + * The class is used to create, update Ppi section of the MSA file + * + * It extends IDialog * */ public class PpisDlg extends IDialog implements ItemListener { diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.java index 8919552e7f..d9ebc0f187 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/SystemTablesDlg.java @@ -39,10 +39,9 @@ import org.tianocore.frameworkwizard.module.Identifications.SystemTables.SystemT import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update SystemTable of MSA/MBD file - * It extends IDialog - * + * The class is used to create, update SystemTables section of the MSA file * + * It extends IDialog * */ public class SystemTablesDlg extends IDialog { diff --git a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/VariablesDlg.java b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/VariablesDlg.java index ca8a5839fe..014e8a7220 100644 --- a/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/VariablesDlg.java +++ b/Tools/Source/FrameworkWizard/src/org/tianocore/frameworkwizard/module/ui/dialog/VariablesDlg.java @@ -39,7 +39,8 @@ import org.tianocore.frameworkwizard.module.Identifications.Variables.VariablesI import org.tianocore.frameworkwizard.workspace.WorkspaceTools; /** - * The class is used to create, update Variables section of the MSA file + * The class is used to create, update Variables section of the MSA file + * * It extends IDialog * */ @@ -132,12 +133,12 @@ public class VariablesDlg extends IDialog { jComboBoxUsage.setBounds(new java.awt.Rectangle(168, 62, 320, 20)); jComboBoxUsage.setPreferredSize(new java.awt.Dimension(320, 20)); jComboBoxUsage - .setToolTipText("" - + "" - + "" - + "" - + "" - + "
ALWAYS_CONSUMEDThe module requires the variable entry to be set
SOMETIMES_CONSUMEDThe module will use the variable entry if it is set.
ALWAYS_PRODUCEDThe module will always write the variable.
SOMETIMES_PRODUCEDThe module will sometimes write the variable.
"); + .setToolTipText("" + + "" + + "" + + "" + + "" + + "
ALWAYS_CONSUMEDThe module requires the variable entry to be set
SOMETIMES_CONSUMEDThe module will use the variable entry if it is set.
ALWAYS_PRODUCEDThe module will always write the variable.
SOMETIMES_PRODUCEDThe module will sometimes write the variable.
"); } return jComboBoxUsage; }