improve the doxygen docu of main.cpp and musredit.h (musredit_qt6).
This commit is contained in:
@@ -27,6 +27,18 @@
|
||||
* 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. *
|
||||
***************************************************************************/
|
||||
|
||||
/**
|
||||
* @file main.cpp
|
||||
* @brief Entry point for the musredit application.
|
||||
* @details This file contains the main() function which initializes the Qt
|
||||
* application and creates the main editor window for musredit.
|
||||
*
|
||||
* @author Andreas Suter
|
||||
* @date 2010-2025
|
||||
* @copyright Copyright (C) 2010-2025 by Andreas Suter
|
||||
* @license GNU General Public License v2 or later
|
||||
*/
|
||||
|
||||
#include <iostream>
|
||||
#include <memory>
|
||||
|
||||
@@ -39,11 +51,36 @@
|
||||
#include "PFitOutputHandler.h"
|
||||
|
||||
/**
|
||||
* <p>musredit is a simple editor based interface to the musrfit programs. It is based on Qt 4.6
|
||||
* of Digia (<code>http://qt.digia.com</code> and <code>http://qt-project.org/</code>).
|
||||
* @brief Main entry point for the musredit application.
|
||||
*
|
||||
* <p>musredit is free software liensenced under GPL 2 or later (for detail license informations see
|
||||
* <code>http://www.gnu.org/licenses</code>).
|
||||
* @details musredit is a simple editor-based interface to the musrfit programs,
|
||||
* providing a graphical environment for creating, editing, and managing
|
||||
* muon spin rotation (μSR) fit parameter files.
|
||||
*
|
||||
* The application is built using the Qt framework and provides the following features:
|
||||
* - Multi-document editing of msr (muon spin rotation) parameter files
|
||||
* - Syntax highlighting for msr file format
|
||||
* - Integration with musrfit analysis tools (musrfit, musrview, msr2data, etc.)
|
||||
* - Recent file tracking and session management
|
||||
*
|
||||
* @par Command Line Options:
|
||||
* - No arguments: Launch the editor with an empty document
|
||||
* - \<msr-files\>: Open the specified msr file(s) for editing
|
||||
* - \c -h, \c --help: Display usage information and exit
|
||||
* - \c -v, \c --version: Display version/git revision information and exit
|
||||
*
|
||||
* @par License:
|
||||
* musredit is free software licensed under GPL v2 or later.
|
||||
* See http://www.gnu.org/licenses for details.
|
||||
*
|
||||
* @param argc Number of command-line arguments
|
||||
* @param argv Array of command-line argument strings
|
||||
*
|
||||
* @return 0 on successful execution or when displaying help/version,
|
||||
* or the Qt application exit code from QApplication::exec()
|
||||
*
|
||||
* @see PTextEdit The main editor window class
|
||||
* @see https://qt.io Qt framework documentation
|
||||
*/
|
||||
int main( int argc, char ** argv )
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user