Skip to content

Feature/paramlist add old description

Yue Wang requested to merge feature/paramlist-add-old-description into master

fixed #959 (closed)

The script extracts the parameters from header files. Per default header files in test and examples are excluded (user defined parameters).

The file parameters.json in doc/doxygen/extradoc is used as the default input. The script will take the explanation, default value, and param type of a detected parameter from the input if given. Otherwise, it tries to automatically choose a value. Hence, if the automatic output is not good for some reason, write the best version into parameters.json. Only ever modify parameters.json since parameters.txt is auto-generated by the script.

In the JSON file, one can define multiple default values for certain parameters. In this case, all different values will be listed in the output file.

Parameters which are not found in code but exist in the input file, will be added to the output.

Usage: ./ (cwd = dumux/bin/doc)

After the execution, information will be written in a log file such as

  • the code where parameters can not be correctly extracted
  • for the parameters with multi entries, all the values are listed. And the default value will be marked with source (input or code)
  • added parameters, which maybe manually added in the JSON file
  • the list of parameters without explanations
Edited by Timo Koch

Merge request reports