diff --git a/src/musredit/PAdmin.cpp b/src/musredit/PAdmin.cpp index 426e4000..7403a7b8 100644 --- a/src/musredit/PAdmin.cpp +++ b/src/musredit/PAdmin.cpp @@ -141,7 +141,8 @@ bool PAdminXMLParser::startElement( const QString&, const QString&, //-------------------------------------------------------------------------- /** *

Routine called when the end XML tag is found. It is used to - * put the filtering tag to 'empty'. + * put the filtering tag to 'empty'. It also resets the fFunc flag in case + * the entry was a theory function. * * \param qName name of the element. */ @@ -285,7 +286,8 @@ bool PAdminXMLParser::characters(const QString& str) //-------------------------------------------------------------------------- /** - *

Called at the end of the XML parse process. + *

Called at the end of the XML parse process. It checks if default paths + * contain system variables, and if so expand them for the further use. */ bool PAdminXMLParser::endDocument() { @@ -321,7 +323,7 @@ bool PAdminXMLParser::endDocument() //-------------------------------------------------------------------------- /** - *

Expands system variables to full path, e.g. $HOME -> \home\user + *

Expands system variables to full path, e.g. $HOME -> \home\user * * \param str path string with none expanded system variables. */ diff --git a/src/musredit/PAdmin.h b/src/musredit/PAdmin.h index 915bb59d..1df302f2 100644 --- a/src/musredit/PAdmin.h +++ b/src/musredit/PAdmin.h @@ -41,6 +41,10 @@ class PAdmin; //--------------------------------------------------------------------------- +/** + *

This structure is keeping informations necessary to handle musrfit + * theory functions (see also https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block). + */ typedef struct { QString name; QString comment; @@ -51,6 +55,12 @@ typedef struct { } PTheory; //--------------------------------------------------------------------------- +/** + * PAdminXMLParser is an XML parser class used to handle the musredit startup + * XML-file called musredit_startup.xml. This startup file contains + * necessary informations about executable pathes, online help informations, + * default font sizes, etc. + */ class PAdminXMLParser : public QXmlDefaultHandler { public: @@ -74,13 +84,20 @@ class PAdminXMLParser : public QXmlDefaultHandler QString expandPath(const QString&); - EAdminKeyWords fKeyWord; - bool fFunc; - PTheory fTheoryItem; - PAdmin *fAdmin; + EAdminKeyWords fKeyWord; ///< key word tag to know how to handle the content + bool fFunc; ///< flag needed to indicate that a new theory function is found + PTheory fTheoryItem; ///< holding the informations necessary for a theory item + PAdmin *fAdmin; ///< a pointer to the main administration class object }; //--------------------------------------------------------------------------- +/** + * The PAdmin class is handling the informations contained in the XML startup file, + * musredit_startup.xml. This startup file contains + * necessary informations about executable pathes, online help informations, + * default font sizes, etc. The XML parsing is done with the help of the PAdminXMLParser + * class. + */ class PAdmin { public: @@ -123,25 +140,25 @@ class PAdmin private: friend class PAdminXMLParser; - QString fFontName; - int fFontSize; + QString fFontName; ///< default font name + int fFontSize; ///< default font size - QString fExecPath; - QString fDefaultSavePath; - QString fMsrDefaultFilePath; - QString fTheoFuncPixmapPath; + QString fExecPath; ///< system path to the musrfit executables + QString fDefaultSavePath; ///< default path where the msr-file should be saved + QString fMsrDefaultFilePath; ///< path where to find musredit source + QString fTheoFuncPixmapPath; ///< path where the default pixmaps can be found - bool fTitleFromDataFile; - bool fEnableMusrT0; + bool fTitleFromDataFile; ///< flag indicating if the title should be extracted from the data file (default settings). + bool fEnableMusrT0; ///< flag indicating if musrT0 shall be enabled at startup from within musredit (default settings) - QString fBeamline; - QString fInstitute; - QString fFileFormat; - bool fLifetimeCorrection; + QString fBeamline; ///< name of the beamline. Used to generate default run header lines. + QString fInstitute; ///< name of the institute. Used to generate default run header lines. + QString fFileFormat; ///< default file format. Used to generate default run header lines. + bool fLifetimeCorrection; ///< flag indicating if by default the lifetime-correction-flag in a single histo file shall be set. QMap fHelpUrl; ///< maps tag to help url - QVector fTheory; + QVector fTheory; ///< stores all known theories. Needed when generating theory blocks from within musredit. }; #endif // _PADMIN_H_ diff --git a/src/musredit/PFindDialog.cpp b/src/musredit/PFindDialog.cpp index b9f7c732..e6a599d4 100644 --- a/src/musredit/PFindDialog.cpp +++ b/src/musredit/PFindDialog.cpp @@ -39,7 +39,12 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Sets up the find dialog. + * + * \param data pointer to the find/replace data structure needed to perform the task. + * \param selection flag indicating if the find shall be restricted to the selected area + * \param parent pointer to the parent object + * \param f qt specific window flags */ PFindDialog::PFindDialog(PFindReplaceData *data, const bool selection, QWidget *parent, Qt::WindowFlags f) : QDialog(parent, f), fData(data) @@ -72,7 +77,8 @@ PFindDialog::PFindDialog(PFindReplaceData *data, const bool selection, QWidget * //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts all the necessary informations from the find dialog, feeds it to the find/replace + * structure and returns a point to this structure. */ PFindReplaceData* PFindDialog::getData() { @@ -89,7 +95,7 @@ PFindReplaceData* PFindDialog::getData() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Enables the find button only if there is any find text entered. */ void PFindDialog::onFindTextAvailable(const QString&) { diff --git a/src/musredit/PFindDialog.h b/src/musredit/PFindDialog.h index e134afda..ae3b932a 100644 --- a/src/musredit/PFindDialog.h +++ b/src/musredit/PFindDialog.h @@ -35,6 +35,10 @@ #include "musredit.h" #include "ui_PFindDialog.h" +//-------------------------------------------------------------------------------------------------- +/** + *

PFindDialog is the class handling the find dialog. + */ class PFindDialog : public QDialog, private Ui::PFindDialog { Q_OBJECT @@ -49,7 +53,7 @@ class PFindDialog : public QDialog, private Ui::PFindDialog virtual void onFindTextAvailable(const QString&); private: - PFindReplaceData *fData; + PFindReplaceData *fData; ///< stores the data necessary to perform find/replace. }; #endif // _PFINDDIALOG_H_ diff --git a/src/musredit/PFitOutputHandler.cpp b/src/musredit/PFitOutputHandler.cpp index 9c8e84af..a12d7a09 100644 --- a/src/musredit/PFitOutputHandler.cpp +++ b/src/musredit/PFitOutputHandler.cpp @@ -37,7 +37,10 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Sets up the fit output handler GUI and starts the actual fit + * + * \param workingDirectory string holding the working directory wished. In this directory the mlog-file will be saved. + * \param cmd command string vector. From this the actuall fit command will be generated and executed. */ PFitOutputHandler::PFitOutputHandler(QString workingDirectory, QVector &cmd) { @@ -86,7 +89,7 @@ PFitOutputHandler::PFitOutputHandler(QString workingDirectory, QVector //---------------------------------------------------------------------------------------------------- /** - *

+ *

Destructor. Checks if the a fit is still running and if yes try to kill it. */ PFitOutputHandler::~PFitOutputHandler() { @@ -108,7 +111,7 @@ PFitOutputHandler::~PFitOutputHandler() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Captures the standard output and adds it to the output text edit. */ void PFitOutputHandler::readFromStdOut() { @@ -119,7 +122,7 @@ void PFitOutputHandler::readFromStdOut() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Captures the standard error and adds it to the output text edit. */ void PFitOutputHandler::readFromStdErr() { @@ -130,7 +133,10 @@ void PFitOutputHandler::readFromStdErr() //---------------------------------------------------------------------------------------------------- /** - *

+ *

If musrfit finishes, crashes, ..., the quit button text will be changed to done. + * + * \param exitCode exit code of musrfit + * \param exitStatus exit status of musrfit */ void PFitOutputHandler::processDone(int exitCode, QProcess::ExitStatus exitStatus) { @@ -141,7 +147,8 @@ void PFitOutputHandler::processDone(int exitCode, QProcess::ExitStatus exitStatu //---------------------------------------------------------------------------------------------------- /** - *

+ *

If the quit button is pressed while the fit is still running, try to terminate musrfit, if this + * does not work, try to kill musrfit. */ void PFitOutputHandler::quitButtonPressed() { diff --git a/src/musredit/PFitOutputHandler.h b/src/musredit/PFitOutputHandler.h index 31d837a2..826be752 100644 --- a/src/musredit/PFitOutputHandler.h +++ b/src/musredit/PFitOutputHandler.h @@ -43,6 +43,12 @@ #include +//--------------------------------------------------------------------------------------- +/** + *

This class is the capturing the output of musrfit and displays it in a dialog so + * the user has the chance to follow the fitting process, warnings, error messages of + * musrfit. + */ class PFitOutputHandler : public QDialog { Q_OBJECT @@ -58,11 +64,11 @@ class PFitOutputHandler : public QDialog virtual void processDone(int exitCode, QProcess::ExitStatus exitStatus); private: - QProcess *fProc; + QProcess *fProc; ///< pointer to the musrfit process - QVBoxLayout *fVbox; - QTextEdit *fOutput; - QPushButton *fQuitButton; + QVBoxLayout *fVbox; ///< pointer to the dialog layout manager + QTextEdit *fOutput; ///< the captured musrfit output is written (read only) into this text edit object. + QPushButton *fQuitButton; ///< quit button, either to interrupt the fit or to close the dialog at the end of the fit. }; #endif // _PFITOUTPUTHANDLER_H_ diff --git a/src/musredit/PGetAsymmetryRunBlockDialog.cpp b/src/musredit/PGetAsymmetryRunBlockDialog.cpp index 761f3976..a85c7bbe 100644 --- a/src/musredit/PGetAsymmetryRunBlockDialog.cpp +++ b/src/musredit/PGetAsymmetryRunBlockDialog.cpp @@ -41,7 +41,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor. + * + * \param helpUrl help url for the asymmetry run block */ PGetAsymmetryRunBlockDialog::PGetAsymmetryRunBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -72,7 +74,7 @@ PGetAsymmetryRunBlockDialog::PGetAsymmetryRunBlockDialog(const QString helpUrl) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the run information line of the asymmetry run block. */ QString PGetAsymmetryRunBlockDialog::getRunHeaderInfo() { @@ -88,7 +90,9 @@ QString PGetAsymmetryRunBlockDialog::getRunHeaderInfo() //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the alpha parameter for the asymmetry run block. + * + * \param present flag indicating if the alpha parameter is used, or a default alpha==1 is going to be used. */ QString PGetAsymmetryRunBlockDialog::getAlphaParameter(bool &present) { @@ -104,7 +108,9 @@ QString PGetAsymmetryRunBlockDialog::getAlphaParameter(bool &present) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the beta parameter for the asymmetry run block + * + * \param present flag indicating if the beta parameter is used, or a default beta==1 is going to be used. */ QString PGetAsymmetryRunBlockDialog::getBetaParameter(bool &present) { @@ -120,7 +126,9 @@ QString PGetAsymmetryRunBlockDialog::getBetaParameter(bool &present) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the map for the asymmetry run block. + * + * \param valid flag indicating if the map is potentially valid. */ QString PGetAsymmetryRunBlockDialog::getMap(bool &valid) { @@ -141,7 +149,10 @@ QString PGetAsymmetryRunBlockDialog::getMap(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the background information for the asymmetry run block. + * + * \param valid flag indicating if a valid background (either backgr.fix or background is given, but not both) + * is present. */ QString PGetAsymmetryRunBlockDialog::getBackground(bool &valid) { @@ -175,7 +186,9 @@ QString PGetAsymmetryRunBlockDialog::getBackground(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns a data range (in bins) entry for the asymmetry run block. + * + * \param valid flag indicating if the data entries are valid. */ QString PGetAsymmetryRunBlockDialog::getData(bool &valid) { @@ -198,7 +211,9 @@ QString PGetAsymmetryRunBlockDialog::getData(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns a t0 parameter for the asymmetry run block. + * + * \param present flag indicating if a t0 parameter is set. */ QString PGetAsymmetryRunBlockDialog::getT0(bool &present) { @@ -218,7 +233,9 @@ QString PGetAsymmetryRunBlockDialog::getT0(bool &present) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns a fit range entry for the asymmetry run block. + * + * \param valid flag indicating if a fit range was provided. */ QString PGetAsymmetryRunBlockDialog::getFitRange(bool &valid) { @@ -239,7 +256,9 @@ QString PGetAsymmetryRunBlockDialog::getFitRange(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

returns the packing/binning of the asymmetry run block. + * + * \param present flag indicating if a packing parameter was provided. */ QString PGetAsymmetryRunBlockDialog::getPacking(bool &present) { @@ -258,7 +277,7 @@ QString PGetAsymmetryRunBlockDialog::getPacking(bool &present) //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the asymmetry run block. */ void PGetAsymmetryRunBlockDialog::helpContent() { diff --git a/src/musredit/PGetAsymmetryRunBlockDialog.h b/src/musredit/PGetAsymmetryRunBlockDialog.h index 1a98a9f5..53c83ff4 100644 --- a/src/musredit/PGetAsymmetryRunBlockDialog.h +++ b/src/musredit/PGetAsymmetryRunBlockDialog.h @@ -34,6 +34,10 @@ #include "ui_PGetAsymmetryRunBlockDialog.h" +//--------------------------------------------------------------------------- +/** + *

Class handling the content of the menu: Edit/Add Block/Asymmetry Run Block. + */ class PGetAsymmetryRunBlockDialog : public QDialog, private Ui::PGetAsymmetryRunBlockDialog { Q_OBJECT @@ -57,7 +61,7 @@ class PGetAsymmetryRunBlockDialog : public QDialog, private Ui::PGetAsymmetryRun void helpContent(); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url for the asymmetry run block }; #endif // _PGETASYMMETRYRUNBLOCKDIALOG_H_ diff --git a/src/musredit/PGetDefaultDialog.cpp b/src/musredit/PGetDefaultDialog.cpp index 7677b24b..d15ccc8b 100644 --- a/src/musredit/PGetDefaultDialog.cpp +++ b/src/musredit/PGetDefaultDialog.cpp @@ -54,7 +54,9 @@ //--------------------------------------------------------------------------- /** - *

+ *

Constructor + * + * \param helpUrl help url for the default dialog */ PGetDefaultDialog::PGetDefaultDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -66,7 +68,9 @@ PGetDefaultDialog::PGetDefaultDialog(const QString helpUrl) : fHelpUrl(helpUrl) //--------------------------------------------------------------------------- /** - *

+ *

Finds the name of the institute in the combo box and selects it. + * + * \param str name of the institute */ void PGetDefaultDialog::setInstitute(const QString &str) { @@ -81,7 +85,9 @@ void PGetDefaultDialog::setInstitute(const QString &str) { //--------------------------------------------------------------------------- /** - *

+ *

Finds the file format in the combo box and selects it. + * + * \param str file format */ void PGetDefaultDialog::setFileFormat(const QString &str) { @@ -97,7 +103,7 @@ void PGetDefaultDialog::setFileFormat(const QString &str) //--------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description fitting the default dialog. */ void PGetDefaultDialog::helpContent() { diff --git a/src/musredit/PGetDefaultDialog.h b/src/musredit/PGetDefaultDialog.h index 7ba7be6a..d46534bc 100644 --- a/src/musredit/PGetDefaultDialog.h +++ b/src/musredit/PGetDefaultDialog.h @@ -39,6 +39,11 @@ #include "ui_PGetDefaultDialog.h" +//--------------------------------------------------------------------------- +/** + *

Handels the default dialog which is used to generate a default asymmetry or + * single histogram msr input file. + */ class PGetDefaultDialog : public QDialog, private Ui::PGetDefaultDialog { Q_OBJECT @@ -60,7 +65,7 @@ class PGetDefaultDialog : public QDialog, private Ui::PGetDefaultDialog virtual void helpContent(); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url for the default dialog }; #endif // _PGETDEFAULTDIALOG_H_ diff --git a/src/musredit/PGetFourierBlockDialog.cpp b/src/musredit/PGetFourierBlockDialog.cpp index 31c630b6..6dc5d068 100644 --- a/src/musredit/PGetFourierBlockDialog.cpp +++ b/src/musredit/PGetFourierBlockDialog.cpp @@ -42,7 +42,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor + * + * \param helpUrl help url address for the Fourier block. */ PGetFourierBlockDialog::PGetFourierBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -62,7 +64,7 @@ PGetFourierBlockDialog::PGetFourierBlockDialog(const QString helpUrl) : fHelpUrl //---------------------------------------------------------------------------------------------------- /** - *

+ *

Checks if the phase parameter is either a number are has the form parXX, where XX is a number. */ void PGetFourierBlockDialog::checkPhaseParameter() { @@ -99,7 +101,7 @@ void PGetFourierBlockDialog::checkPhaseParameter() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Transfers the data of the dialog into a valid msr-file Fourier block string. */ void PGetFourierBlockDialog::fillFourierBlock() { @@ -125,7 +127,7 @@ void PGetFourierBlockDialog::fillFourierBlock() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the Fourier block. */ void PGetFourierBlockDialog::helpContent() { diff --git a/src/musredit/PGetFourierBlockDialog.h b/src/musredit/PGetFourierBlockDialog.h index d2e82eb9..cb09c8ee 100644 --- a/src/musredit/PGetFourierBlockDialog.h +++ b/src/musredit/PGetFourierBlockDialog.h @@ -36,6 +36,10 @@ #include "ui_PGetFourierBlockDialog.h" +//------------------------------------------------------------------------------- +/** + *

Handles the Fourier dialog. + */ class PGetFourierBlockDialog : public QDialog, private Ui::PGetFourierBlockDialog { Q_OBJECT @@ -51,8 +55,8 @@ class PGetFourierBlockDialog : public QDialog, private Ui::PGetFourierBlockDialo void helpContent(); private: - QString fFourierBlock; - QString fHelpUrl; + QString fFourierBlock; ///< keeps the msr Fourier block + QString fHelpUrl; ///< help url for the Fourier block }; #endif // _PGETFOURIERBLOCKDIALOG_H_ diff --git a/src/musredit/PGetFunctionsBlockDialog.cpp b/src/musredit/PGetFunctionsBlockDialog.cpp index b660ed61..71777b9c 100644 --- a/src/musredit/PGetFunctionsBlockDialog.cpp +++ b/src/musredit/PGetFunctionsBlockDialog.cpp @@ -43,7 +43,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor. + * + * \param helpUrl help url for the FUNCTIONS block. */ PGetFunctionsBlockDialog::PGetFunctionsBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -56,7 +58,8 @@ PGetFunctionsBlockDialog::PGetFunctionsBlockDialog(const QString helpUrl) : fHel //---------------------------------------------------------------------------------------------------- /** - *

+ *

Adds a function to the FUNCTIONS block text edit after carrying out some primitve tests about + * the consistency of the function (far from being a syntax/semantic checker!!). */ void PGetFunctionsBlockDialog::addFunction() { @@ -100,7 +103,7 @@ void PGetFunctionsBlockDialog::addFunction() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the FUNCTIONS block. */ void PGetFunctionsBlockDialog::helpContent() { diff --git a/src/musredit/PGetFunctionsBlockDialog.h b/src/musredit/PGetFunctionsBlockDialog.h index e119b155..03044dc7 100644 --- a/src/musredit/PGetFunctionsBlockDialog.h +++ b/src/musredit/PGetFunctionsBlockDialog.h @@ -34,6 +34,10 @@ #include "ui_PGetFunctionsBlockDialog.h" +//----------------------------------------------------------------------------------- +/** + *

Handles the content of the FUNCTIONS block dialog. + */ class PGetFunctionsBlockDialog : public QDialog, private Ui::PGetFunctionsBlockDialog { Q_OBJECT @@ -48,7 +52,7 @@ class PGetFunctionsBlockDialog : public QDialog, private Ui::PGetFunctionsBlockD void helpContent(); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url address for the FUNCTIONS block. }; #endif // _PGETFUNCTIONSBLOCKDIALOG_H_ diff --git a/src/musredit/PGetNonMusrRunBlockDialog.cpp b/src/musredit/PGetNonMusrRunBlockDialog.cpp index 1649cff0..59b2abdc 100644 --- a/src/musredit/PGetNonMusrRunBlockDialog.cpp +++ b/src/musredit/PGetNonMusrRunBlockDialog.cpp @@ -39,7 +39,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor + * + * \param helpUrl help url for the NonMusr run block. */ PGetNonMusrRunBlockDialog::PGetNonMusrRunBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -64,7 +66,7 @@ PGetNonMusrRunBlockDialog::PGetNonMusrRunBlockDialog(const QString helpUrl) : fH //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts the run header information from the dialog, and returns it as a string. */ QString PGetNonMusrRunBlockDialog::getRunHeaderInfo() { @@ -80,7 +82,9 @@ QString PGetNonMusrRunBlockDialog::getRunHeaderInfo() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts the map from the dialog, and returns it as a string. + * + * \param valid flag indicating of the map is potentially being valid. */ QString PGetNonMusrRunBlockDialog::getMap(bool &valid) { @@ -101,7 +105,9 @@ QString PGetNonMusrRunBlockDialog::getMap(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts xy-data from the dialog and returns it as a string. + * + * \param valid flag showing that x/y-data are present. */ QString PGetNonMusrRunBlockDialog::getXYData(bool &valid) { @@ -121,7 +127,10 @@ QString PGetNonMusrRunBlockDialog::getXYData(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts the fit-range from the dialog and returns it as a string. If not fit-range was given, + * a fit-range from 0 to 10 us will be returned and the valid flag will be set to false. + * + * \param valid flag showing if a fit-range is given. */ QString PGetNonMusrRunBlockDialog::getFitRange(bool &valid) { @@ -142,7 +151,7 @@ QString PGetNonMusrRunBlockDialog::getFitRange(bool &valid) //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the NonMusr run block. */ void PGetNonMusrRunBlockDialog::helpContent() { diff --git a/src/musredit/PGetNonMusrRunBlockDialog.h b/src/musredit/PGetNonMusrRunBlockDialog.h index 2187b3dd..ca78ce11 100644 --- a/src/musredit/PGetNonMusrRunBlockDialog.h +++ b/src/musredit/PGetNonMusrRunBlockDialog.h @@ -34,6 +34,10 @@ #include "ui_PGetNonMusrRunBlockDialog.h" +//------------------------------------------------------------------------------------- +/** + *

Handles the content of the NonMusr run block dialog. + */ class PGetNonMusrRunBlockDialog : public QDialog, private Ui::PGetNonMusrRunBlockDialog { Q_OBJECT @@ -50,7 +54,7 @@ class PGetNonMusrRunBlockDialog : public QDialog, private Ui::PGetNonMusrRunBloc void helpContent(); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url address for the NonMusr run block. }; #endif // _PGETNONMUSRRUNBLOCKDIALOG_H_ diff --git a/src/musredit/PGetParameterBlockDialog.cpp b/src/musredit/PGetParameterBlockDialog.cpp index c45abeb3..96063fb3 100644 --- a/src/musredit/PGetParameterBlockDialog.cpp +++ b/src/musredit/PGetParameterBlockDialog.cpp @@ -42,7 +42,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor. + * + * \param helpUrl help url of the PARAMETER block. */ PGetParameterBlockDialog::PGetParameterBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -63,6 +65,9 @@ PGetParameterBlockDialog::PGetParameterBlockDialog(const QString helpUrl) : fHel /** *

This event filter is filtering out the return key, and if present adds the current parameters * to the parameter list. + * + * \param obj object which was generating the event. + * \param ev event of the object. */ bool PGetParameterBlockDialog::eventFilter( QObject *obj, QEvent *ev ) { @@ -85,7 +90,7 @@ bool PGetParameterBlockDialog::eventFilter( QObject *obj, QEvent *ev ) //---------------------------------------------------------------------------------------------------- /** - *

+ *

Adds a parameter to the text edit window. */ void PGetParameterBlockDialog::paramAdd() { @@ -209,7 +214,7 @@ void PGetParameterBlockDialog::paramAdd() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the FITPARAMETER block. */ void PGetParameterBlockDialog::helpContent() { diff --git a/src/musredit/PGetParameterBlockDialog.h b/src/musredit/PGetParameterBlockDialog.h index b58d0f22..61e9971a 100644 --- a/src/musredit/PGetParameterBlockDialog.h +++ b/src/musredit/PGetParameterBlockDialog.h @@ -34,6 +34,10 @@ #include "ui_PGetParameterBlockDialog.h" +//----------------------------------------------------------------------------------- +/** + *

Handles the content of the PARAMETER block dialog. + */ class PGetParameterBlockDialog : public QDialog, private Ui::PGetParameterBlockDialog { Q_OBJECT @@ -51,7 +55,7 @@ class PGetParameterBlockDialog : public QDialog, private Ui::PGetParameterBlockD void helpContent(); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url of the PARAMETER block description. }; #endif // _PGETPARAMETERBLOCKDIALOG_H_ diff --git a/src/musredit/PGetPlotBlockDialog.cpp b/src/musredit/PGetPlotBlockDialog.cpp index 81023061..37705d51 100644 --- a/src/musredit/PGetPlotBlockDialog.cpp +++ b/src/musredit/PGetPlotBlockDialog.cpp @@ -41,7 +41,9 @@ //---------------------------------------------------------------------------------------------------- /** - *

+ *

Constructor. + * + * \param helpUrl help url for the PLOT block. */ PGetPlotBlockDialog::PGetPlotBlockDialog(const QString helpUrl) : fHelpUrl(helpUrl) { @@ -62,7 +64,8 @@ PGetPlotBlockDialog::PGetPlotBlockDialog(const QString helpUrl) : fHelpUrl(helpU //---------------------------------------------------------------------------------------------------- /** - *

+ *

Extracts the information of the top part of the dialog, constructs a msr-file PLOT block and + * writes it into the text edit window. */ void PGetPlotBlockDialog::addPlot() { @@ -152,7 +155,7 @@ void PGetPlotBlockDialog::addPlot() //---------------------------------------------------------------------------------------------------- /** - *

+ *

Generates a help content window showing the description of the PLOT block. */ void PGetPlotBlockDialog::helpContent() { @@ -167,6 +170,9 @@ void PGetPlotBlockDialog::helpContent() //---------------------------------------------------------------------------------------------------- /** *

This event filter is filtering out the return key, and if present adds the current plot. + * + * \param obj object which is triggering the event + * \param ev the triggered event */ bool PGetPlotBlockDialog::eventFilter( QObject *obj, QEvent *ev ) { diff --git a/src/musredit/PGetPlotBlockDialog.h b/src/musredit/PGetPlotBlockDialog.h index f4e06dc4..3bd39e60 100644 --- a/src/musredit/PGetPlotBlockDialog.h +++ b/src/musredit/PGetPlotBlockDialog.h @@ -34,6 +34,10 @@ #include "ui_PGetPlotBlockDialog.h" +//-------------------------------------------------------------------------- +/** + *

Handels content of the PLOT block dialog. + */ class PGetPlotBlockDialog : public QDialog, private Ui::PGetPlotBlockDialog { Q_OBJECT @@ -51,7 +55,7 @@ class PGetPlotBlockDialog : public QDialog, private Ui::PGetPlotBlockDialog bool eventFilter( QObject *obj, QEvent *ev ); private: - QString fHelpUrl; + QString fHelpUrl; ///< help url for the PLOT block }; #endif // _PGETPLOTBLOCKDIALOG_H_ diff --git a/src/musredit/main.cpp b/src/musredit/main.cpp index daa8938d..3742d01c 100644 --- a/src/musredit/main.cpp +++ b/src/musredit/main.cpp @@ -41,7 +41,8 @@ using namespace std; *

musredit is a simple editor based interface to the musrfit programs. It is based on Qt 4.6 * of Nokia (http://qt.nokia.com). * - *

musredit is open source LGPL and GPL (for detail license informations see http://qt.nokia.com/products/licensing). + *

musredit is free software liensenced under GPL 2 or later (for detail license informations see + * http://www.gnu.org/licenses). * *

The source code can be downloaded from http://savannah.psi.ch/viewcvs/trunk/analysis/musrfit/src/musredit/?root=nemu%2Flem. */