improve the doxygen docu of musrWiz.
This commit is contained in:
@@ -17,7 +17,10 @@
|
||||
|
||||
//-------------------------------------------------------------------
|
||||
/**
|
||||
* @brief PParam::init initializes all member variables to default/undefined values.
|
||||
*
|
||||
* Sets name, posErr, boundLow, and boundHigh to "UnDef", number to -1,
|
||||
* and value/step to 0.0.
|
||||
*/
|
||||
void PParam::init()
|
||||
{
|
||||
@@ -32,7 +35,13 @@ void PParam::init()
|
||||
|
||||
//-------------------------------------------------------------------
|
||||
/**
|
||||
* @brief Prints the command-line syntax help for musrWiz.
|
||||
*
|
||||
* Displays usage information including available command-line options:
|
||||
* - --version/-v: prints git version information
|
||||
* - --debug [0|1|2]: enables debug output for instrument definitions and/or functions
|
||||
* - --log: writes a log file with the generated msr-file path
|
||||
* - --help: shows this help
|
||||
*/
|
||||
void musrWiz_syntax()
|
||||
{
|
||||
@@ -48,7 +57,20 @@ void musrWiz_syntax()
|
||||
|
||||
//-------------------------------------------------------------------
|
||||
/**
|
||||
* @brief Main entry point for the musrWiz application.
|
||||
*
|
||||
* Parses command-line arguments and launches the musrWiz wizard GUI.
|
||||
* Creates the PAdmin object to load configuration files (instrument definitions,
|
||||
* musrfit functions, etc.) and then starts the wizard workflow.
|
||||
*
|
||||
* After the wizard completes, if requested via --log option, writes a log file
|
||||
* containing the path to the generated msr-file. If musrt0 should be called
|
||||
* (T0_FROM_MUSR_T0), either logs this flag or starts musrt0 directly.
|
||||
*
|
||||
* @param argc Number of command-line arguments.
|
||||
* @param argv Array of command-line argument strings.
|
||||
* @return 0 on success (or --help/--version), 1 on initialization failure,
|
||||
* or the wizard result code.
|
||||
*/
|
||||
int main(int argc, char *argv[])
|
||||
{
|
||||
|
||||
Reference in New Issue
Block a user