Commit 20805ad0 authored by Stefan Tauner's avatar Stefan Tauner
Browse files

fiji_scripts: documentation fixes

parent db166019
......@@ -794,7 +794,7 @@ EXCLUDE_SYMLINKS = NO
# Note that the wildcards are matched against the file with absolute path, so to
# exclude all test directories for example use the pattern */test/*
EXCLUDE_PATTERNS = */FIJI/AnySerialPort.pm
EXCLUDE_PATTERNS = */FIJI/AnySerialPort.pm */Tk/DynaMouseWheelBind.pm
# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
# (namespaces, classes, functions, etc.) that should be excluded from the
......
......@@ -121,9 +121,14 @@ sub ini2constkey {
use base 'Exporter';
# our @EXPORT = ();
our @EXPORT = (keys(%designmap), keys(%fiumap));
our @EXPORT_OK = (keys(%designmap), 'DESIGNMAP', keys(%fiumap), 'FIUMAP');
## @var @EXPORT_TAGS Export Tags
#
# By default this file exports only the individual subhashes.
# If 'all' is specified in the use/import clause then additionally the
# whole mappings will be exported as DESIGNMAP and FIUMAP.
our %EXPORT_TAGS = (
all => \@EXPORT_OK,
default => \@EXPORT,
......
......@@ -135,10 +135,10 @@ sub save ($) {
}
## @function read_settingsfile ($fiji_ini_file)
## @function read_settingsfile ($phase, $fiji_ini_file)
# @brief Load the FIJI Settings file containing design and FIU constants.
#
# \param $phase Tool flow phase the settings stored in the given file
# \param phase Tool flow phase the settings stored in the given file
# need to be compatible with.
# \param fiji_ini_file The name of an .ini file with FIJI Settings:
# - a 'consts' block containing the constants specified by
......@@ -413,7 +413,7 @@ sub _rename_import {
}
## @function _sanitize_fiu (%$fiu_ref)
## @function _sanitize_fiu (%$fiu_ref, $phase)
# @brief Convert and sanity check FIJI Settings.
#
# \param fiu_ref a reference to a hash containing FIJI Settings for a
......@@ -478,7 +478,7 @@ sub _validate_hashmap ($$;$) {
}
## @function _sanitize_design (%$consts_ref)
## @function _sanitize_design (%$consts_ref, $phase)
# @brief Sanity check FIJI Design Settings.
#
# The function deals with sanity checks for the values
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment