Merge pull request #1216 from AllenInstitute/feature/1216-check-help-string-analysis-functions

Check help string analysis functions

Author: t-b

Packages/MIES/MIES_AnalysisFunctionHelpers.ipf

@@ -502,6 +502,29 @@ Function/S AFH_GetListOfAnalysisParams(func, mode)
 	endif
 End
 
+/// @brief Get help string from optional `$func_GetHelp`
+///
+/// @param func Analysis function `V3`
+/// @param name Parameter name
+Function/S AFH_GetHelpForAnalysisParameter(string func, string name)
+
+	FUNCREF AF_PROTO_PARAM_HELP_GETTER_V3 f = $(func + "_GetHelp")
+
+	if(!FuncRefIsAssigned(FuncRefInfo(f)))
+		return ""
+	endif
+
+	AssertOnAndClearRTError()
+	try
+		return f(name); AbortOnRTE
+	catch
+		ClearRTError()
+		// ignoring errors here
+	endtry
+
+	return ""
+End
+
 /// @defgroup AnalysisFunctionParameterHelpers Analysis Helper functions for dealing with user parameters
 
 /// @brief Return a semicolon separated list of user parameters

Packages/MIES/MIES_WaveBuilderPanel.ipf

@@ -1804,27 +1804,16 @@ static Function WBP_UpdateParameterWave()
 	listWave[][%Help] = ""
 	helpWave[][] = ""
 
-	FUNCREF AF_PROTO_PARAM_HELP_GETTER_V3 f = $(genericFunc + "_GetHelp")
-
-	if(FuncRefIsAssigned(FuncRefInfo(f)))
-
-		numEntries = DimSize(listWave, ROWS)
-		for(i = 0; i < numEntries; i += 1)
-			name = listWave[i][%Name]
-
-			if(WhichListItem(name, suggNames) != -1)
-				AssertOnAndClearRTError()
-				try
-					help = f(name); AbortOnRTE
-					listWave[i][%Help] = help
-					helpWave[i][%Help] = LineBreakingIntoPar(help, minimumWidth = 40)
-				catch
-					ClearRTError()
-					// ignoring errors here
-				endtry
-			endif
-		endfor
-	endif
+	numEntries = DimSize(listWave, ROWS)
+	for(i = 0; i < numEntries; i += 1)
+		name = listWave[i][%Name]
+
+		if(WhichListItem(name, suggNames) != -1)
+			help = AFH_GetHelpForAnalysisParameter(genericFunc, name)
+			listWave[i][%Help] = help
+			helpWave[i][%Help] = LineBreakingIntoPar(help, minimumWidth = 40)
+		endif
+	endfor
 End
 
 /// @brief Toggle the analysis parameter GUI

Packages/Testing-MIES/UTF_AnalysisFunctionManagement.ipf

@@ -311,6 +311,29 @@ static Function EnsureCorrectUserAnalysis()
 	REQUIRE_EQUAL_VAR(ItemsInList(FunctionList("InvalidSignature", ";", "WIN:UserAnalysisFunctions.ipf")), 1)
 End
 
+Function CheckHelpStringsOfAllAnalysisFunctions()
+	string funcs, genericFunc, params, names, name, help
+	variable i, j, numFuncs, numParams
+
+	funcs = WBP_GetAnalysisFunctions(ANALYSIS_FUNCTION_VERSION_V3)
+	// remove our test help functions which do nasty things
+	funcs = GrepList(funcs, "Params[[:digit:]]*_V3", 1)
+
+	numFuncs = ItemsInList(funcs)
+	for(i = 0; i < numFuncs; i += 1)
+		genericFunc = StringFromList(i, funcs)
+		params = AFH_GetListOfAnalysisParams(genericFunc, REQUIRED_PARAMS | OPTIONAL_PARAMS)
+
+		names = AFH_GetListOfAnalysisParamNames(params)
+		numParams = ItemsInList(names)
+		for(j = 0; j < numParams; j += 1)
+			name = StringFromList(j, names)
+			help = AFH_GetHelpForAnalysisParameter(genericFunc, name)
+			CHECK_PROPER_STR(help)
+		endfor
+	endfor
+End
+
 // invalid analysis functions
 // UTF_TD_GENERATOR HardwareMain#DeviceNameGeneratorMD1
 static Function AFT1([str])