LMU/musrfit
5
0
Fork 0
Code Issues 6 Pull Requests Actions Packages Projects Releases 4 Activity

adopted the technical docu, according to the new sphinx user docu.

Browse Source
This commit is contained in:
suter_a
2018-07-04 12:43:26 +02:00
parent 7fa203b350
commit 86e1544c0e
10 changed files with 77 additions and 150 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
src/msr2data.cpp
View File

@ -162,8 +162,7 @@ void msr2data_syntax()
cout << endl << " collected form the msr-files 2046_tf_histo.msr and so on.";
cout << endl;
cout << endl << " For further information please refer to";
cout << endl << " http://lmu.web.psi.ch/musrfit/user/MUSR/Msr2Data.html";
cout << endl << " https://intranet.psi.ch/MUSR/Msr2Data";
cout << endl << " http://lmu.web.psi.ch/musrfit/user/html/msr2data.html#msr2data";
cout << endl << endl;
}
@ -499,9 +498,9 @@ int msr2data_paramList(vector<string> &arg, vector<unsigned int> &paramList)
/**
* <p>msr2data is used to generate msr-files based on template msr-files, automatically fit these new msr-files,
* collect fitting parameters, etc. For a detailed description see
* \htmlonly <a href="https://intranet.psi.ch/MUSR/Msr2Data">musr2data online help</a>
* \htmlonly <a href="http://lmu.web.psi.ch/musrfit/user/html/msr2data.html#msr2data">musr2data online help</a>
* \endhtmlonly
* \latexonly msr2data online help: \texttt{https://intranet.psi.ch/MUSR/Msr2Data}
* \latexonly msr2data online help: \texttt{http://lmu.web.psi.ch/musrfit/user/html/msr2data.html#msr2data}
* \endlatexonly
*
* \param argc number of arguments

2
src/musredit/PAdmin.h
View File

@ -43,7 +43,7 @@ class PAdmin;
//---------------------------------------------------------------------------
/**
* <p>This structure is keeping informations necessary to handle musrfit
* theory functions (see also <code>https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block</code>).
* theory functions (see also <code>http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block</code>).
*/
typedef struct {
QString name;

24
src/musredit/PTextEdit.cpp
View File

@ -682,7 +682,7 @@ void PTextEdit::doConnections( PSubTextEdit *e )
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file title. See also https://intranet.psi.ch/MUSR/MusrFit#4_1_The_Title
* <p>Start the dialog to enter a msr-file title. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-title
*/
void PTextEdit::insertTitle()
{
@ -691,7 +691,7 @@ void PTextEdit::insertTitle()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file fit-parameter block. See also https://intranet.psi.ch/MUSR/MusrFit#4_2_The_FITPARAMETER_Block
* <p>Start the dialog to enter a msr-file fit-parameter block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-fitparameter-block
*/
void PTextEdit::insertParameterBlock()
{
@ -700,7 +700,7 @@ void PTextEdit::insertParameterBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file theory block. See also https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block
* <p>Start the dialog to enter a msr-file theory block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block
*/
void PTextEdit::insertTheoryBlock()
{
@ -709,7 +709,7 @@ void PTextEdit::insertTheoryBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Insert a selected theory function. See also https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block
* <p>Insert a selected theory function. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block
*
* \param a action of the selected theory function
*/
@ -720,7 +720,7 @@ void PTextEdit::insertTheoryFunction(QAction *a)
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file function block. See also https://intranet.psi.ch/MUSR/MusrFit#4_4_The_FUNCTIONS_Block
* <p>Start the dialog to enter a msr-file function block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-functions-block
*/
void PTextEdit::insertFunctionBlock()
{
@ -729,7 +729,7 @@ void PTextEdit::insertFunctionBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file asymmetry run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file asymmetry run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertAsymRunBlock()
{
@ -738,7 +738,7 @@ void PTextEdit::insertAsymRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file single histogram run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file single histogram run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertSingleHistRunBlock()
{
@ -747,7 +747,7 @@ void PTextEdit::insertSingleHistRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file nonMusr run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file nonMusr run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertNonMusrRunBlock()
{
@ -756,7 +756,7 @@ void PTextEdit::insertNonMusrRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Inserts a default command block. See also https://intranet.psi.ch/MUSR/MusrFit#4_6_The_COMMANDS_Block
* <p>Inserts a default command block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-commands-block
*/
void PTextEdit::insertCommandBlock()
{
@ -765,7 +765,7 @@ void PTextEdit::insertCommandBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file Fourier block. See also https://intranet.psi.ch/MUSR/MusrFit#4_7_The_FOURIER_Block
* <p>Start the dialog to enter a msr-file Fourier block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-fourier-block
*/
void PTextEdit::insertFourierBlock()
{
@ -774,7 +774,7 @@ void PTextEdit::insertFourierBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file plot block. See also https://intranet.psi.ch/MUSR/MusrFit#4_7_The_PLOT_Block
* <p>Start the dialog to enter a msr-file plot block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-plot-block
*/
void PTextEdit::insertPlotBlock()
{
@ -783,7 +783,7 @@ void PTextEdit::insertPlotBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Inserts a default statistics block. See also https://intranet.psi.ch/MUSR/MusrFit#4_9_The_STATISTIC_Block
* <p>Inserts a default statistics block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-statistic-block
*/
void PTextEdit::insertStatisticBlock()
{

2
src/musredit_qt5/musredit/PAdmin.h
View File

@ -43,7 +43,7 @@ class PAdmin;
//---------------------------------------------------------------------------
/**
* <p>This structure is keeping informations necessary to handle musrfit
* theory functions (see also <code>https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block</code>).
* theory functions (see also <code>http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block</code>).
*/
typedef struct {
QString name;

30
src/musredit_qt5/musredit/PTextEdit.cpp
View File

@ -925,7 +925,7 @@ void PTextEdit::doConnections( PSubTextEdit *e )
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file title. See also https://intranet.psi.ch/MUSR/MusrFit#4_1_The_Title
* <p>Start the dialog to enter a msr-file title. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-title
*/
void PTextEdit::insertTitle()
{
@ -934,7 +934,7 @@ void PTextEdit::insertTitle()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file fit-parameter block. See also https://intranet.psi.ch/MUSR/MusrFit#4_2_The_FITPARAMETER_Block
* <p>Start the dialog to enter a msr-file fit-parameter block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-fitparameter-block
*/
void PTextEdit::insertParameterBlock()
{
@ -943,7 +943,7 @@ void PTextEdit::insertParameterBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file theory block. See also https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block
* <p>Start the dialog to enter a msr-file theory block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block
*/
void PTextEdit::insertTheoryBlock()
{
@ -952,7 +952,7 @@ void PTextEdit::insertTheoryBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Insert a selected theory function. See also https://intranet.psi.ch/MUSR/MusrFit#4_3_The_THEORY_Block
* <p>Insert a selected theory function. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-theory-block
*
* \param a action of the selected theory function
*/
@ -963,7 +963,7 @@ void PTextEdit::insertTheoryFunction(QAction *a)
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file function block. See also https://intranet.psi.ch/MUSR/MusrFit#4_4_The_FUNCTIONS_Block
* <p>Start the dialog to enter a msr-file function block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-functions-block
*/
void PTextEdit::insertFunctionBlock()
{
@ -972,7 +972,7 @@ void PTextEdit::insertFunctionBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file asymmetry run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file asymmetry run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertAsymRunBlock()
{
@ -981,7 +981,7 @@ void PTextEdit::insertAsymRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file single histogram run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file single histogram run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertSingleHistRunBlock()
{
@ -990,7 +990,7 @@ void PTextEdit::insertSingleHistRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file nonMusr run block. See also https://intranet.psi.ch/MUSR/MusrFit#4_5_The_RUN_Block
* <p>Start the dialog to enter a msr-file nonMusr run block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-run-block
*/
void PTextEdit::insertNonMusrRunBlock()
{
@ -999,7 +999,7 @@ void PTextEdit::insertNonMusrRunBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Inserts a default command block. See also https://intranet.psi.ch/MUSR/MusrFit#4_6_The_COMMANDS_Block
* <p>Inserts a default command block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-commands-block
*/
void PTextEdit::insertCommandBlock()
{
@ -1008,7 +1008,7 @@ void PTextEdit::insertCommandBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file Fourier block. See also https://intranet.psi.ch/MUSR/MusrFit#4_7_The_FOURIER_Block
* <p>Start the dialog to enter a msr-file Fourier block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-fourier-block
*/
void PTextEdit::insertFourierBlock()
{
@ -1017,7 +1017,7 @@ void PTextEdit::insertFourierBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Start the dialog to enter a msr-file plot block. See also https://intranet.psi.ch/MUSR/MusrFit#4_7_The_PLOT_Block
* <p>Start the dialog to enter a msr-file plot block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-plot-block
*/
void PTextEdit::insertPlotBlock()
{
@ -1026,7 +1026,7 @@ void PTextEdit::insertPlotBlock()
//----------------------------------------------------------------------------------------------------
/**
* <p>Inserts a default statistics block. See also https://intranet.psi.ch/MUSR/MusrFit#4_9_The_STATISTIC_Block
* <p>Inserts a default statistics block. See also http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#the-statistic-block
*/
void PTextEdit::insertStatisticBlock()
{
@ -2745,9 +2745,9 @@ void PTextEdit::mupp()
{
QString cmd("");
cmd = fAdmin->getExecPath() + "/mupp";
#if defined(Q_OS_DARWIN) || defined(Q_OS_MAC)
cmd = QString("/Applications/mupp.app/Contents/MacOS/mupp");
#endif
#if defined(Q_OS_DARWIN) || defined(Q_OS_MAC)
cmd = QString("/Applications/mupp.app/Contents/MacOS/mupp");
#endif
QProcess *proc = new QProcess(this);

4
src/musrfit.cpp
View File

@ -422,9 +422,9 @@ void musrfit_dump_root(char *fileName, PRunListCollection *runList)
/**
* <p>The musrfit program is used to fit muSR data.
* For a detailed description/usage of the program, please see
* \htmlonly <a href="https://intranet.psi.ch/MUSR/MusrFit">musrfit online help</a>
* \htmlonly <a href="http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrfit">musrfit online help</a>
* \endhtmlonly
* \latexonly musrfit online help: \texttt{https://intranet.psi.ch/MUSR/MusrFit}
* \latexonly musrfit online help: \texttt{http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrfit}
* \endlatexonly
*
* <b>return:</b>

4
src/musrt0.cpp
View File

@ -198,9 +198,9 @@ Int_t musrt0_getMaxBin(const PDoubleVector *data)
/**
* <p>The musrt0 program is used to set graphically t0's, data- and background-ranges.
* For a detailed description/usage of the program, please see
* \htmlonly <a href="https://intranet.psi.ch/MUSR/MusrFit">musrt0 online help</a>
* \htmlonly <a href="http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrt0">musrt0 online help</a>
* \endhtmlonly
* \latexonly musrt0 online help: \texttt{https://intranet.psi.ch/MUSR/MusrFit}
* \latexonly musrt0 online help: \texttt{http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrt0}
* \endlatexonly
*
* <b>return:</b>

4
src/musrview.cpp
View File

@ -83,9 +83,9 @@ void musrview_syntax()
* <p>The musrview program is used to show muSR fit results in graphical form.
* From it also Fourier transforms, difference between data an theory can be formed.
* For a detailed description/usage of the program, please see
* \htmlonly <a href="https://intranet.psi.ch/MUSR/MusrFit">musrview online help</a>
* \htmlonly <a href="http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrview">musrview online help</a>
* \endhtmlonly
* \latexonly musrview online help: \texttt{https://intranet.psi.ch/MUSR/MusrFit}
* \latexonly musrview online help: \texttt{http://lmu.web.psi.ch/musrfit/user/html/user-manual.html#musrview}
* \endlatexonly
*
* <b>return:</b>