From f51b136df40190cfbe6383cf701bb12bac6ea6ce Mon Sep 17 00:00:00 2001
From: Andreas Suter <andreas.suter@psi.ch>
Date: Tue, 9 Mar 2010 19:47:05 +0000
Subject: [PATCH] start to add some more serious description and fixing a minor
 bug in the resource file.

---
 src/musredit/main.cpp     | 12 ++++++++++--
 src/musredit/musredit.h   | 10 ++++++++++
 src/musredit/musredit.qrc |  1 -
 3 files changed, 20 insertions(+), 3 deletions(-)

diff --git a/src/musredit/main.cpp b/src/musredit/main.cpp
index 0de8fa8a..daa8938d 100644
--- a/src/musredit/main.cpp
+++ b/src/musredit/main.cpp
@@ -37,17 +37,25 @@ using namespace std;
 #include "PTextEdit.h"
 #include "PFitOutputHandler.h"
 
+/**
+ * <p>musredit is a simple editor based interface to the musrfit programs. It is based on Qt 4.6
+ * of Nokia (<code>http://qt.nokia.com</code>).
+ *
+ * <p>musredit is open source LGPL and GPL (for detail license informations see <code>http://qt.nokia.com/products/licensing</code>).
+ *
+ * <p>The source code can be downloaded from <code>http://savannah.psi.ch/viewcvs/trunk/analysis/musrfit/src/musredit/?root=nemu%2Flem</code>.
+ */
 int main( int argc, char ** argv ) 
 {
   Q_INIT_RESOURCE(musredit);
 
   if (argc == 2) {
     if (!strcmp(argv[1], "--help") || !strcmp(argv[1], "-h")) {
-      cout << endl << "usage: musrgui [<msr-files>] | -h, --help | -v, --version";
+      cout << endl << "usage: musredit [<msr-files>] | -h, --help | -v, --version";
       cout << endl << endl;
       return 0;
     } else if (!strcmp(argv[1], "--version") || !strcmp(argv[1], "-v")) {
-      cout << endl << "musrgui version: $Id$";
+      cout << endl << "musredit version: $Id$";
       cout << endl << endl;
       return 0;
     }
diff --git a/src/musredit/musredit.h b/src/musredit/musredit.h
index 7fd3cf61..64caf258 100644
--- a/src/musredit/musredit.h
+++ b/src/musredit/musredit.h
@@ -34,6 +34,12 @@
 
 #include <QString>
 
+//-------------------------------------------------------------------------------------------------
+/**
+ * <p> This structure is used in conjunction to <code>msr2data</code>. It stores the necessary
+ * parameters to handle <code>msr2data</code>. For a detailed description of the meaning of these
+ * parameters see <code>msr2data --help</code> and the online documentation.
+ */
 typedef struct {
   int firstRun;
   int lastRun;
@@ -54,6 +60,10 @@ typedef struct {
   bool fitOnly;
 } PMsr2DataParam;
 
+//-------------------------------------------------------------------------------------------------
+/**
+ * This structure is used to handle find (and replace) within <code>musredit</code> properly.
+ */
 typedef struct {
   QString findText;
   QString replaceText;
diff --git a/src/musredit/musredit.qrc b/src/musredit/musredit.qrc
index 6229aa6f..37841ef7 100644
--- a/src/musredit/musredit.qrc
+++ b/src/musredit/musredit.qrc
@@ -23,7 +23,6 @@
     <file>images/musrt0.xpm</file>
     <file>images/musrview.xpm</file>
     <file>latex_images/abragam.png</file>
-    <file>latex_images/abragam.gif</file>
     <file>latex_images/asymmetry.png</file>
     <file>latex_images/bessel.png</file>
     <file>latex_images/combiLGKT.png</file>