Skip to content

Commit

Permalink
Code Style: Unify comma in function signatures
Browse files Browse the repository at this point in the history
  • Loading branch information
Garados007 committed Jul 28, 2023
1 parent 82967e0 commit 40879cc
Show file tree
Hide file tree
Showing 10 changed files with 28 additions and 28 deletions.
14 changes: 7 additions & 7 deletions Packages/MIES/MIES_Configuration.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -435,7 +435,7 @@ End
///
/// @param fName file name of configuration file to read configuration
/// @param rigFile [optional, default = ""] name of secondary rig configuration file with complementary data. This parameter is valid when loading for a DA_Ephys panel
Function CONF_RestoreWindow(string fName[, string rigFile])
Function CONF_RestoreWindow(string fName, [string rigFile])

variable jsonID, restoreMask
string input, wName, errMsg, fullFilePath, panelType
Expand Down Expand Up @@ -1216,7 +1216,7 @@ End
/// @param winHandle window handle
/// @param uKey [optional, default = EXPCONFIG_UDATA_WINHANDLE] userdata key that stores the handle value
/// @returns Window name of the window with the given handle; empty string if not found.
static Function/S CONF_FindWindow(winHandle[, uKey])
static Function/S CONF_FindWindow(winHandle, [uKey])
string winHandle, uKey

variable i, j, numWin, numSubWin
Expand Down Expand Up @@ -1249,7 +1249,7 @@ End
/// @param ctrlName Control name
/// @param jsonPath [optional, default = n/a] When given: the control is expected to be a named json object (with the control nice name)
/// If not given: the jsons second level (assuming default format) is searched for the associated object. This is slower.
static Function CONF_RestoreControl(wName, restoreMask, jsonID, ctrlName[, jsonPath])
static Function CONF_RestoreControl(wName, restoreMask, jsonID, ctrlName, [jsonPath])
string wName
variable restoreMask, jsonID
string ctrlName, jsonPath
Expand Down Expand Up @@ -1468,7 +1468,7 @@ End
/// @param[in] saveMask bit pattern based configuration setting for saving @sa WindowControlSavingMask
/// @param[in] excCtrlTypes [optional, default = ""], list of control type codes for excluded control types for saving e.g. "1;6;" to exclude all buttons and charts
/// @returns json ID of object where all controls where serialized into
Function CONF_AllWindowsToJSON(wName, saveMask[, excCtrlTypes])
Function CONF_AllWindowsToJSON(wName, saveMask, [excCtrlTypes])
string wName
variable saveMask
string excCtrlTypes
Expand Down Expand Up @@ -1529,7 +1529,7 @@ End
/// @param saveMask Bit mask which properties are saved from WindowControlSavingMask constants
/// @param excCtrlTypes [optional, default = ""] List of excluded control types that are ignored
/// @returns jsonID ID of json containing the serialized GUI data
Function CONF_WindowToJSON(wName, saveMask[, excCtrlTypes])
Function CONF_WindowToJSON(wName, saveMask, [excCtrlTypes])
string wName
variable saveMask
string excCtrlTypes
Expand Down Expand Up @@ -2509,7 +2509,7 @@ End
/// @param[in] loadRigFile [optional, default 0] when set, load the rig file instead
///
/// @returns jsonId or NaN if data was not present
static Function [variable jsonId, string txtData] CONF_LoadConfigUsedForDAEphysPanel(string wName[, variable loadRigFile])
static Function [variable jsonId, string txtData] CONF_LoadConfigUsedForDAEphysPanel(string wName, [variable loadRigFile])

string fName, str

Expand Down Expand Up @@ -2543,7 +2543,7 @@ static Function CONF_TransferPreviousDAEphysJson(variable jsonId, variable prevJ
endfor
End

static Function CONF_RemoveRigElementsFromDAEphysJson(variable jsonId, variable rigJsonId[, string jsonPath])
static Function CONF_RemoveRigElementsFromDAEphysJson(variable jsonId, variable rigJsonId, [string jsonPath])

string newJsonPath, key

Expand Down
2 changes: 1 addition & 1 deletion Packages/MIES/MIES_DataBrowser.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -596,7 +596,7 @@ End
/// @param win Name of the DataBrowser
/// @param index Index of the sweep
/// @param bdi [optional, default = n/a] BufferedDrawInfo structure, when given buffered draw is used.
Function DB_AddSweepToGraph(string win, variable index[, STRUCT BufferedDrawInfo &bdi])
Function DB_AddSweepToGraph(string win, variable index, [STRUCT BufferedDrawInfo &bdi])
STRUCT TiledGraphSettings tgs

variable sweepNo, traceIndex
Expand Down
6 changes: 3 additions & 3 deletions Packages/MIES/MIES_Epochs.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -693,7 +693,7 @@ End
/// @param[in] level level of epoch
/// @param[in] lowerlimit [optional, default = -Inf] epBegin is limited between lowerlimit and Inf, epEnd must be > this limit
/// @param[in] upperlimit [optional, default = Inf] epEnd is limited between -Inf and upperlimit, epBegin must be < this limit
static Function EP_AddEpoch(device, channel, channelType, epBegin, epEnd, epTags, epShortName, level[, lowerlimit, upperlimit])
static Function EP_AddEpoch(device, channel, channelType, epBegin, epEnd, epTags, epShortName, level, [lowerlimit, upperlimit])
string device
variable channel, channelType
variable epBegin, epEnd
Expand Down Expand Up @@ -911,7 +911,7 @@ End
/// This is required for callers who want to read epochs during MID_SWEEP_EVENT in analysis functions.
///
/// @returns Text wave with epoch information, only rows fitting the input parameters are returned. Can also be a null wave.
Function/WAVE EP_GetEpochs(WAVE numericalValues, WAVE textualValues, variable sweepNo, variable channelType, variable channelNumber, string shortname[, variable treelevel, WAVE/T epochsWave])
Function/WAVE EP_GetEpochs(WAVE numericalValues, WAVE textualValues, variable sweepNo, variable channelType, variable channelNumber, string shortname, [variable treelevel, WAVE/T epochsWave])

variable index, epochCnt, midSweep
string regexp
Expand Down Expand Up @@ -1087,7 +1087,7 @@ static Function/WAVE EP_GetGaps(WAVE numericalValues, WAVE textualValues, variab
End

/// @brief Returns the following epoch of a given epoch name in a specified tree level
Function/WAVE EP_GetNextEpoch(WAVE numericalValues, WAVE textualValues, variable sweepNo, variable channelType, variable channelNumber, string shortname, variable treelevel[, variable ignoreGaps])
Function/WAVE EP_GetNextEpoch(WAVE numericalValues, WAVE textualValues, variable sweepNo, variable channelType, variable channelNumber, string shortname, variable treelevel, [variable ignoreGaps])

variable currentEnd, dim

Expand Down
4 changes: 2 additions & 2 deletions Packages/MIES/MIES_GuiPopupMenuExt.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -583,7 +583,7 @@ End
/// @param[in] menuList 1d text wave with menu items
/// @param[in] method [optional, default = PEXT_SUBSPLIT_DEFAULT] sets how the menu items are split to sub menus @sa PEXT_SubMenuSplitting
/// @returns 1d text wave where each element contains a list of menu items. Each element represents a sub menu.
Function/WAVE PEXT_SplitToSubMenus(menuList[, method])
Function/WAVE PEXT_SplitToSubMenus(menuList, [method])
WAVE/T/Z menuList
variable method

Expand Down Expand Up @@ -662,7 +662,7 @@ End
///
/// @param[in] splitMenu 1d text wave with menu item lists for sub menus as returned by PEXT_SplitToSubMenus()
/// @param[in] method [optional, default = PEXT_SUBNAMEGEN_DEFAULT] sets how the sub menu names are generated @sa PEXT_SubMenuNameGeneration
Function PEXT_GenerateSubMenuNames(splitMenu[, method])
Function PEXT_GenerateSubMenuNames(splitMenu, [method])
WAVE/T/Z splitMenu
variable method

Expand Down
4 changes: 2 additions & 2 deletions Packages/MIES/MIES_GuiUtilities.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -925,7 +925,7 @@ End
/// @param[in] orientation [optional: default not set] filter orientation of axes see @ref AxisOrientationConstants
/// @param[in] mode [optional: default #AXIS_RANGE_DEFAULT] filter returned axis information by mode see @ref AxisPropModeConstants
/// @return free wave with rows = axes, cols = axes info, dimlabel of rows is axis name
Function/Wave GetAxesProperties(graph[, axesRegexp, orientation, mode])
Function/Wave GetAxesProperties(graph, [axesRegexp, orientation, mode])
string graph, axesRegexp
variable orientation, mode

Expand Down Expand Up @@ -990,7 +990,7 @@ End
/// @param[in] axesRegexp [optional: default not set] filter axes names list by this optional regular expression
/// @param[in] orientation [optional: default not set] filter orientation of axes see @ref AxisOrientationConstants
/// @param[in] mode [optional: default 0] axis set mode see @ref AxisPropModeConstants
Function SetAxesProperties(graph, props[, axesRegexp, orientation, mode])
Function SetAxesProperties(graph, props, [axesRegexp, orientation, mode])
string graph
Wave props
string axesRegexp
Expand Down
2 changes: 1 addition & 1 deletion Packages/MIES/MIES_MiesUtilities.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -2648,7 +2648,7 @@ End
/// @param experiment name of the experiment the sweep stems from
/// @param channelSelWave channel selection wave
/// @param bdi [optional, default = n/a] initialized BufferedDrawInfo structure, when given draw calls are buffered instead for later execution @sa OVS_EndIncrementalUpdate
Function CreateTiledChannelGraph(string graph, WAVE config, variable sweepNo, WAVE numericalValues, WAVE/T textualValues, STRUCT TiledGraphSettings &tgs, DFREF sweepDFR, WAVE/T axisLabelCache, variable &traceIndex, string experiment, WAVE channelSelWave[, STRUCT BufferedDrawInfo &bdi])
Function CreateTiledChannelGraph(string graph, WAVE config, variable sweepNo, WAVE numericalValues, WAVE/T textualValues, STRUCT TiledGraphSettings &tgs, DFREF sweepDFR, WAVE/T axisLabelCache, variable &traceIndex, string experiment, WAVE channelSelWave, [STRUCT BufferedDrawInfo &bdi])

variable axisIndex, numChannels
variable numDACs, numADCs, numTTLs, i, j, k, hasPhysUnit, hardwareType
Expand Down
4 changes: 2 additions & 2 deletions Packages/MIES/MIES_SweepFormula.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -4080,7 +4080,7 @@ static Function/WAVE SF_OperationPowerSpectrum(variable jsonId, string jsonPath,
return SFH_GetOutputForExecutor(output, graph, SF_OP_POWERSPECTRUM, clear=input)
End

static Function/WAVE SF_PowerSpectrumRatio(WAVE/Z input, variable ratioFreq, variable deltaHz[, WAVE fitData])
static Function/WAVE SF_PowerSpectrumRatio(WAVE/Z input, variable ratioFreq, variable deltaHz, [WAVE fitData])

string sLeft, sRight, maxSigma, minAmp
variable err, left, right, minFreq, maxFreq, endFreq, base
Expand Down Expand Up @@ -4944,7 +4944,7 @@ End
/// @param singleResult [optional, default 0], if set then the first dataSet is retrieved from the waveRef wave and returned, the waveRef wave is disposed
/// @param checkExist [optional, default 0], only valid if singleResult=1, if set then the data wave in the single dataSet retrieved must exist
/// @param useVariables [optional, default 1], when not set, hint the function that the formula string contains only an expression and no variable definitions
Function/WAVE SF_ExecuteFormula(string formula, string graph[, variable singleResult, variable checkExist, variable useVariables])
Function/WAVE SF_ExecuteFormula(string formula, string graph, [variable singleResult, variable checkExist, variable useVariables])

variable jsonId

Expand Down
10 changes: 5 additions & 5 deletions Packages/MIES/MIES_SweepFormula_Helpers.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -253,7 +253,7 @@ End
/// All programmer error checks must still use ASSERT().
///
/// UTF_NOINSTRUMENTATION
Function SFH_ASSERT(variable condition, string message[, variable jsonId])
Function SFH_ASSERT(variable condition, string message, [variable jsonId])

if(!condition)
if(!ParamIsDefault(jsonId))
Expand Down Expand Up @@ -604,7 +604,7 @@ Function SFH_AddToArgSetupStack(WAVE output, WAVE/Z input, string argSetupStr, [
JSON_Release(argStackId)
End

Function/WAVE SFH_GetOutputForExecutorSingle(WAVE/Z data, string graph, string opShort[, variable discardOpStack, WAVE clear, string dataType])
Function/WAVE SFH_GetOutputForExecutorSingle(WAVE/Z data, string graph, string opShort, [variable discardOpStack, WAVE clear, string dataType])

discardOpStack = ParamIsDefault(discardOpStack) ? 0 : !!discardOpStack
if(!ParamIsDefault(clear))
Expand All @@ -627,7 +627,7 @@ Function/WAVE SFH_GetOutputForExecutorSingle(WAVE/Z data, string graph, string o
return SFH_GetOutputForExecutor(output, graph, opShort)
End

Function/WAVE SFH_GetOutputForExecutor(WAVE output, string win, string opShort[, WAVE clear])
Function/WAVE SFH_GetOutputForExecutor(WAVE output, string win, string opShort, [WAVE clear])

if(!ParamIsDefault(clear))
SFH_CleanUpInput(clear)
Expand Down Expand Up @@ -657,7 +657,7 @@ static Function SFH_ConvertAllReturnDataToPermanent(WAVE/WAVE output, string win
End

/// @brief Retrieves from an argument the first dataset and disposes the argument
Function/WAVE SFH_ResolveDatasetElementFromJSON(variable jsonId, string jsonPath, string graph, string opShort, variable argNum[, variable checkExist])
Function/WAVE SFH_ResolveDatasetElementFromJSON(variable jsonId, string jsonPath, string graph, string opShort, variable argNum, [variable checkExist])

checkExist = ParamIsDefault(checkExist) ? 0 : !!checkExist

Expand All @@ -679,7 +679,7 @@ End
/// @param newDataType data type of output
/// @param argSetup [optional, default=$""] 2d text wave with argument setup of operation @sa SFH_GetNewArgSetupWave
/// @param keepX [optional, default=0] When set then xvalues and xlabel of output are kept.
Function SFH_TransferFormulaDataWaveNoteAndMeta(WAVE/WAVE input, WAVE/WAVE output, string opShort, string newDataType[, WAVE/T argSetup, variable keepX])
Function SFH_TransferFormulaDataWaveNoteAndMeta(WAVE/WAVE input, WAVE/WAVE output, string opShort, string newDataType, [WAVE/T argSetup, variable keepX])

variable sweepNo, numResults, i, setXLabel, size
string opStack, argSetupStr, inDataType
Expand Down
8 changes: 4 additions & 4 deletions Packages/MIES/MIES_Utilities.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -846,7 +846,7 @@ End
/// @param wv wave reference, can be numeric or text
/// @param caseSensitive [optional, default = 1] Indicates whether comparison should be case sensitive. Applies only if the input wave is a text wave
/// @param dontDuplicate [optional, default = 0] for a single element input wave no new free wave is created but the input wave is returned.
threadsafe Function/WAVE GetUniqueEntries(WAVE wv[, variable caseSensitive, variable dontDuplicate])
threadsafe Function/WAVE GetUniqueEntries(WAVE wv, [variable caseSensitive, variable dontDuplicate])

variable numRows

Expand Down Expand Up @@ -909,7 +909,7 @@ End
/// @param dontDuplicate [optional, default = 0] for a single element input wave no new free wave is created but the input wave is returned.
///
/// @return free wave with unique entries
threadsafe static Function/WAVE GetUniqueTextEntries(WAVE/T wv[, variable caseSensitive, variable dontDuplicate])
threadsafe static Function/WAVE GetUniqueTextEntries(WAVE/T wv, [variable caseSensitive, variable dontDuplicate])

variable numEntries, numDuplicates, i

Expand Down Expand Up @@ -4901,7 +4901,7 @@ End
/// @param[in] fileFilter [optional, default = "Plain Text Files (*.txt):.txt;All Files:.*;"] file filter string in Igor specific notation.
/// @param[in] message [optional, default = "Select file"] window title of the save file dialog.
/// @returns loaded string data and full path fileName
Function [string data, string fName] LoadTextFile(string fileName[, string fileFilter, string message])
Function [string data, string fName] LoadTextFile(string fileName, [string fileFilter, string message])

variable fNum, zFlag

Expand Down Expand Up @@ -6186,7 +6186,7 @@ End
/// @param input Wave to perform FFT on
/// @param winFunc [optional, defaults to NONE] FFT window function
/// @param padSize [optional, defaults to the next power of 2 of the input wave row size] Target size used for padding
threadsafe Function/WAVE DoFFT(WAVE input[, string winFunc, variable padSize])
threadsafe Function/WAVE DoFFT(WAVE input, [string winFunc, variable padSize])

if(ParamIsDefault(padSize))
padSize = TP_GetPowerSpectrumLength(DimSize(input, ROWS))
Expand Down
2 changes: 1 addition & 1 deletion Packages/tests/Basic/UTF_SweepFormula.ipf
Original file line number Diff line number Diff line change
Expand Up @@ -2227,7 +2227,7 @@ static Function TestOperationSelect()

End

static Function CheckSweepsFromData(WAVE/WAVE dataWref, WAVE sweepRef, variable numResults, WAVE chanIndex[, WAVE ranges])
static Function CheckSweepsFromData(WAVE/WAVE dataWref, WAVE sweepRef, variable numResults, WAVE chanIndex, [WAVE ranges])

variable i

Expand Down

0 comments on commit 40879cc

Please sign in to comment.