improve the doxygen docu of musrStep.

src/musredit_qt6/musrStep/musrStep.cpp

@@ -1,3 +1,47 @@
+/***************************************************************************
+
+  musrStep.cpp
+
+  Author: Andreas Suter
+  e-mail: andreas.suter@psi.ch
+
+***************************************************************************/
+
+/***************************************************************************
+ *   Copyright (C) 2007-2025 by Andreas Suter                              *
+ *   andreas.suter@psi.ch                                                  *
+ *                                                                         *
+ *   This program is free software; you can redistribute it and/or modify  *
+ *   it under the terms of the GNU General Public License as published by  *
+ *   the Free Software Foundation; either version 2 of the License, or     *
+ *   (at your option) any later version.                                   *
+ *                                                                         *
+ *   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.                          *
+ *                                                                         *
+ *   You should have received a copy of the GNU General Public License     *
+ *   along with this program; if not, write to the                         *
+ *   Free Software Foundation, Inc.,                                       *
+ *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
+ ***************************************************************************/
+
+/**
+ * @file musrStep.cpp
+ * @brief Main entry point for the musrStep application.
+ * @details musrStep is a Qt-based GUI application for adjusting fit parameter
+ * step sizes in muSR msr-files. It provides an interactive interface to view,
+ * select, and modify the step values of fit parameters used by musrfit.
+ *
+ * The application supports both automatic step size adjustment based on
+ * parameter naming conventions and manual scaling by user-defined factors.
+ *
+ * @author Andreas Suter
+ * @date 2007-2025
+ * @copyright GNU General Public License v2 or later
+ */
+
 #include <iostream>
 #include <cstring>
 
@@ -11,6 +55,13 @@
 #include "PMusrStep.h"
 
 //-------------------------------------------------------------------------
+/**
+ * @brief Prints the command-line syntax and usage information to stdout.
+ * @details This function displays the available command-line options:
+ * - \<fln\>: The msr-file name to open and edit
+ * - -v, --version: Display git version information
+ * - -h, --help: Display this help message
+ */
 void musrStep_syntax()
 {
   std::cout << std::endl;
@@ -22,6 +73,19 @@ void musrStep_syntax()
 }
 
 //-------------------------------------------------------------------------
+/**
+ * @brief Main entry point for the musrStep application.
+ * @details Parses command-line arguments and launches the musrStep GUI.
+ *
+ * The application expects exactly one argument which can be:
+ * - A path to an msr-file to open
+ * - -v or --version to display version information
+ * - -h or --help to display usage information
+ *
+ * @param argc Number of command-line arguments
+ * @param argv Array of command-line argument strings
+ * @return 0 on success, 1 on error or invalid usage
+ */
 int main(int argc, char *argv[])
 {
   char fln[1024];