added some more docu

src/musredit/PMsr2DataDialog.cpp

@@ -41,7 +41,10 @@
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>Constructor.
+ *
+ * \param msr2DataParam data structure keeping the necessary information to feed msr2data
+ * \param helpUrl help url for msr2data
  */
 PMsr2DataDialog::PMsr2DataDialog(PMsr2DataParam *msr2DataParam, const QString helpUrl) : fMsr2DataParam(msr2DataParam), fHelpUrl(helpUrl)
 {
@@ -101,7 +104,7 @@ PMsr2DataDialog::PMsr2DataDialog(PMsr2DataParam *msr2DataParam, const QString he
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>returns the msr2data relavant parameters from the GUI.
  */
 PMsr2DataParam* PMsr2DataDialog::getMsr2DataParam()
 {
@@ -140,7 +143,10 @@ PMsr2DataParam* PMsr2DataDialog::getMsr2DataParam()
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when in the 'Run List Input', the 'First' text field is activated. It clears any
+ * entries in 'Run List' and 'Run List File Name'. It furthermore sets the run tag.
+ *
+ * \param str string content of the QTextEdit field.
  */
 void PMsr2DataDialog::runFirstEntered(const QString &str)
 {
@@ -158,7 +164,10 @@ void PMsr2DataDialog::runFirstEntered(const QString &str)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when in the 'Run List Input', the 'Last' text field is activated. It clears any
+ * entries in 'Run List' and 'Run List File Name'. It furthermore sets the run tag.
+ *
+ * \param str string content of the QTextEdit field.
  */
 void PMsr2DataDialog::runLastEntered(const QString &str)
 {
@@ -178,7 +187,10 @@ void PMsr2DataDialog::runLastEntered(const QString &str)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when in the 'Run List Input', the 'Run List' text field is activated. It clears any
+ * entries in 'First', 'Last', and 'Run List File Name'. It furthermore sets the run tag.
+ *
+ * \param str string content of the QTextEdit field.
  */
 void PMsr2DataDialog::runListEntered(const QString &str)
 {
@@ -197,7 +209,10 @@ void PMsr2DataDialog::runListEntered(const QString &str)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when in the 'Run List Input', the 'Run List File Name' text field is activated. It clears any
+ * entries in 'First', 'Last', and 'Run List'. It furthermore sets the run tag.
+ *
+ * \param str string content of the QTextEdit field.
  */
 void PMsr2DataDialog::runListFileNameEntered(const QString &str)
 {
@@ -216,7 +231,10 @@ void PMsr2DataDialog::runListFileNameEntered(const QString &str)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when in 'Template Run Input', the 'Template Run Number' text field is activated.
+ * It set at the same time the fit-only flag to false.
+ *
+ * \param str string content of the QTextEdit field.
  */
 void PMsr2DataDialog::templateRunEntered(const QString &str)
 {
@@ -227,7 +245,10 @@ void PMsr2DataDialog::templateRunEntered(const QString &str)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when the 'Create msr-File only' QCheckBox under 'Options' is activated.
+ * Sets at the same time the fit-only flag to false.
+ *
+ * \param buttonState state of the button.
  */
 void PMsr2DataDialog::createMsrFileOnlyChanged(int buttonState)
 {
@@ -238,7 +259,11 @@ void PMsr2DataDialog::createMsrFileOnlyChanged(int buttonState)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>SLOT: called when the 'Fit Only' QCheckBox under 'Options' is activated.
+ * Sets at the same time the create-msr-file-only flag to false. Clears the 'Template Run Number'
+ * field.
+ *
+ * \param buttonState state of the button.
  */
 void PMsr2DataDialog::fitOnlyChanged(int buttonState)
 {
@@ -250,7 +275,7 @@ void PMsr2DataDialog::fitOnlyChanged(int buttonState)
 
 //----------------------------------------------------------------------------------------------------
 /**
- * <p>
+ * <p>Generates a help content window showing the description for msr2data.
  */
 void PMsr2DataDialog::helpContent()
 {

src/musredit/PMsr2DataDialog.h

@@ -38,6 +38,10 @@
 #include "musredit.h"
 #include "ui_PMsr2DataDialog.h"
 
+/**
+ * <p>Class handling the content of the MusrFit/Msr2Data GUI. It collects the input
+ * for B.M. Wojek's msr2data program.
+ */
 class PMsr2DataDialog : public QDialog, private Ui::PMsr2DataDialog
 {
   Q_OBJECT
@@ -60,7 +64,7 @@ class PMsr2DataDialog : public QDialog, private Ui::PMsr2DataDialog
 
   private:
     int fRunTag; ///< -1 = not valid, 0 = first last, 1 = run list, 2 = run list file name
-    PMsr2DataParam *fMsr2DataParam;
+    PMsr2DataParam *fMsr2DataParam; ///< data structure used to handle the necessary input for msr2data.
     QString fHelpUrl; ///< help url for the Fourier block
 };
 

src/musredit/musredit.h

@@ -41,23 +41,23 @@
  * parameters see <code>msr2data --help</code> and the online documentation.
  */
 typedef struct {
-  int firstRun;
+  int firstRun;                ///< first run number of a sequence of runs (usage 2 of msr2data)
-  int lastRun;
+  int lastRun;                 ///< last run number of a sequence of runs (usage 2 of msr2data)
-  QString runList;
+  QString runList;             ///< list of run numbers (usage 3 of msr2data)
-  QString runListFileName;
+  QString runListFileName;     ///< run list filename (usage 4 of msr2data)
-  QString msrFileExtension;
+  QString msrFileExtension;    ///< msr filename extension, e.g. '0100_h13.msr' -> '_h13'
-  int templateRunNo;
+  int templateRunNo;           ///< fit template run number
-  QString dbOutputFileName;
+  QString dbOutputFileName;    ///< output file name for the generated (trumf-like) db-file.
-  bool writeDbHeader;
+  bool writeDbHeader;          ///< flag indicating if a db header shall be generated (== !noheader in msr2data)
-  bool summaryFilePresent;
+  bool summaryFilePresent;     ///< flag indicating if a LEM summary file is present (== !nosummary in msr2data)
-  bool keepMinuit2Output;
+  bool keepMinuit2Output;      ///< flag indicating if the minuit2 output shall be kept ('-k' in msr2data)
-  bool writeColumnData;
+  bool writeColumnData;        ///< flag indicating if instead of a db-file a column data ascii file shall be written ('data' in msr2data)
-  bool recreateDbFile;
+  bool recreateDbFile;         ///< true = recreate db-file, false = append to present db-file
-  bool chainFit;
+  bool chainFit;               ///< true = chain fit, i.e. the template for a fit is the preceeding run. false = the template is always the source for the new msr-file
-  bool openFilesAfterFitting;
+  bool openFilesAfterFitting;  ///< true = open msr-file after fit in musredit. false = do not open msr-file after fit.
-  bool titleFromDataFile;
+  bool titleFromDataFile;      ///< flag indicating if the title for the msr-file shall be extracted from the data-file ('-t' in msr2data)
-  bool createMsrFileOnly;
+  bool createMsrFileOnly;      ///< true = just create the msr-files without any fitting ('msr-<template>' in msr2data)
-  bool fitOnly;
+  bool fitOnly;                ///< true = just perform the fits wihtout generating any msr-files ('fit' in msr2data).
 } PMsr2DataParam;
 
 //-------------------------------------------------------------------------------------------------
@@ -65,14 +65,14 @@ typedef struct {
  * This structure is used to handle find (and replace) within <code>musredit</code> properly.
  */
 typedef struct {
-  QString findText;
+  QString findText;     ///< text to be found
-  QString replaceText;
+  QString replaceText;  ///< replacement string
-  bool caseSensitive;
+  bool caseSensitive;   ///< true = case sensitive
-  bool wholeWordsOnly;
+  bool wholeWordsOnly;  ///< true = look for whole words only
-  bool fromCursor;
+  bool fromCursor;      ///< true = start the find/replace form the cursor position only
-  bool findBackwards;
+  bool findBackwards;   ///< true = reversed search
-  bool selectedText;
+  bool selectedText;    ///< true = handle only the selected text
-  bool promptOnReplace;
+  bool promptOnReplace; ///< true = request on OK from the user before performing the replace action
 } PFindReplaceData;
 
 #endif // _MUSREDIT_H_