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

fixed some doxygen bugs in the technical docu.

Browse Source
This commit is contained in:
suter_a 2020-05-19 15:33:21 +02:00
parent 0fa40bbc73
commit 4554296dde
5 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/mupp_dox.cfg
View File

@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = ./technical/mupp OUTPUT_DIRECTORY = ./technical/html/mupp
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and
@ -1984,14 +1984,14 @@ ALLEXTERNALS = NO
# listed. # listed.
# The default value is: YES. # The default value is: YES.
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = NO
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will # the related pages index. If set to NO, only the current project's pages will
# be listed. # be listed.
# The default value is: YES. # The default value is: YES.
EXTERNAL_PAGES = YES EXTERNAL_PAGES = NO
# The PERL_PATH should be the absolute path and name of the perl script # The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl'). # interpreter (i.e. the result of 'which perl').

6
doc/musredit_dox.cfg
View File

@ -58,7 +58,7 @@ PROJECT_LOGO =
# entered, it will be relative to the location where doxygen was started. If # entered, it will be relative to the location where doxygen was started. If
# left blank the current directory will be used. # left blank the current directory will be used.
OUTPUT_DIRECTORY = ./technical/musredit OUTPUT_DIRECTORY = ./technical/html/musredit
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub- # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
# directories (in 2 levels) under the output directory of each output format and # directories (in 2 levels) under the output directory of each output format and
@ -1982,14 +1982,14 @@ ALLEXTERNALS = NO
# listed. # listed.
# The default value is: YES. # The default value is: YES.
EXTERNAL_GROUPS = YES EXTERNAL_GROUPS = NO
# If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in # If the EXTERNAL_PAGES tag is set to YES all external pages will be listed in
# the related pages index. If set to NO, only the current project's pages will # the related pages index. If set to NO, only the current project's pages will
# be listed. # be listed.
# The default value is: YES. # The default value is: YES.
EXTERNAL_PAGES = YES EXTERNAL_PAGES = NO
# The PERL_PATH should be the absolute path and name of the perl script # The PERL_PATH should be the absolute path and name of the perl script
# interpreter (i.e. the result of 'which perl'). # interpreter (i.e. the result of 'which perl').

4
doc/musrfit.dox
View File

@ -50,11 +50,11 @@ under Linux, Mac OS X, and (with some more work) under Windows. The musrfit fram
- musrgui (obsolete): an editor to handle msr-files, calling musrfit, etc. from within the editor, based on Qt3.x. - musrgui (obsolete): an editor to handle msr-files, calling musrfit, etc. from within the editor, based on Qt3.x.
Only bug fixing will be done on this version, and if you have >= Qt4.6 available you should use musredit instead. Only bug fixing will be done on this version, and if you have >= Qt4.6 available you should use musredit instead.
- **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on >= Qt4.6. A technical documentation of musredit can be found - **musredit**: an editor to handle msr-files, calling musrfit, etc. from within a simple text editor, based on >= Qt4.6. A technical documentation of musredit can be found
\htmlonly <a href="../musredit/html/index.html">here.</a>\endhtmlonly \htmlonly <a href="./musredit/html/index.html">here.</a>\endhtmlonly
- **musrWiz** (beta): allows to create an initial msr-file by a step-by-step instruction wizard. - **musrWiz** (beta): allows to create an initial msr-file by a step-by-step instruction wizard.
- **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors. - **musrStep**: allows to efficiently deal with initial step values of msr-files. Especially useful for msr-files dealing with many runs/detectors.
- **mupp**: is the muSR parameter plotter. It allows to plot values in db- or dat-files (collections). A technical documentation of mupp can be found - **mupp**: is the muSR parameter plotter. It allows to plot values in db- or dat-files (collections). A technical documentation of mupp can be found
\htmlonly <a href="../mupp/html/index.html">here.</a>\endhtmlonly \htmlonly <a href="./mupp/html/index.html">here.</a>\endhtmlonly
- **MuSRFit**: a graphical user interface based on PerlQt (written by Z. Salman) for an easy to use interface to the musrfit framework. - **MuSRFit**: a graphical user interface based on PerlQt (written by Z. Salman) for an easy to use interface to the musrfit framework.
Compared to the more general approach of writing msr-files, it has some limitations, though it might be easier for a first user of the musrfit framework. Compared to the more general approach of writing msr-files, it has some limitations, though it might be easier for a first user of the musrfit framework.
- **any2many**: should be a "universal" muSR data-file-format converter. - **any2many**: should be a "universal" muSR data-file-format converter.

4
doc/musrfit_dox.cfg
View File

@ -2030,8 +2030,8 @@ SKIP_FUNCTION_MACROS = YES
# the path). If a tag file is not located in the directory in which doxygen is # the path). If a tag file is not located in the directory in which doxygen is
# run, you must also specify the path to the tagfile here. # run, you must also specify the path to the tagfile here.
TAGFILES = dox-tags/musredit.tag=./technical/musredit\ TAGFILES = dox-tags/musredit.tag=musredit/html \
dox-tags/mupp.tag=./technical/mupp dox-tags/mupp.tag=mupp/html
# When a file name is specified after GENERATE_TAGFILE, doxygen will create a # When a file name is specified after GENERATE_TAGFILE, doxygen will create a
# tag file that is based on the input files it reads. See section "Linking to # tag file that is based on the input files it reads. See section "Linking to

2
src/musredit_qt5/mupp/mupp.dox
View File

@ -14,6 +14,6 @@
<p>mupp allows to quickly plot parameters found in db-/dat-files. db-/dat-files are typically generated by msr2data from msr-files after fitting. A db-/dat-file is a collection of fitting parameters from a collection of muSR measurements. For instance a db-/dat-file collects a full temperature scan, a field scan, an energy scan, etc. <p>mupp allows to quickly plot parameters found in db-/dat-files. db-/dat-files are typically generated by msr2data from msr-files after fitting. A db-/dat-file is a collection of fitting parameters from a collection of muSR measurements. For instance a db-/dat-file collects a full temperature scan, a field scan, an energy scan, etc.
mupp allows to load these collections, select parameters in a x/y fashion and allows to plot it. It furthermore allows to create new variables which are mathematical transformations of the parameter vectors of a collection. <p>mupp allows to load these collections, select parameters in a x/y fashion and allows to plot it. It furthermore allows to create new variables which are mathematical transformations of the parameter vectors of a collection.
*/ */