Skip to content

Commit e69c675

Browse files
author
Matthias Kastner
committed
convert to doxygen comments
1 parent d833751 commit e69c675

File tree

1 file changed

+19
-19
lines changed

1 file changed

+19
-19
lines changed

procedures/CodeBrowser.ipf

Lines changed: 19 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -217,15 +217,15 @@ Function/S interpretParameters(funcInfo)
217217
return str
218218
End
219219

220-
// check if Function has as a structure as first parameter
221-
//
222-
// the structure definition has to be in the first line after the function definition
223-
//
224-
// @param[in] funcInfo output of FunctionInfo for the function in question
225-
// @param[out] structureName matched name of the structure as string.
226-
// Not changed if 0 is returned.
227-
//
228-
// @returns 1 if function has such a parameter, 0 otherwise
220+
/// check if Function has as a structure as first parameter
221+
///
222+
/// the structure definition has to be in the first line after the function definition
223+
///
224+
/// @param[in] funcInfo output of FunctionInfo for the function in question
225+
/// @param[out] structureName matched name of the structure as string.
226+
/// Not changed if 0 is returned.
227+
///
228+
/// @returns 1 if function has such a parameter, 0 otherwise
229229
Function GetStructureArgument(funcInfo, structureName)
230230
string funcInfo
231231
string &structureName
@@ -927,16 +927,16 @@ Function/S ProcedureListRemoveEnding(list)
927927
return niceList
928928
End
929929

930-
// Get the specified line of code from a function
931-
//
932-
// @see getProcedureText
933-
//
934-
// @param funcInfo output of FunctionInfo for the function in question
935-
// @param lineNo line number relative to the function definition
936-
// set to -1 to return lines before the procedure that are not part of the preceding macro or function
937-
// see `DisplayHelpTopic("ProcedureText")`
938-
//
939-
// @returns lines of code from a function inside a procedure file
930+
/// Get the specified line of code from a function
931+
///
932+
/// @see getProcedureText
933+
///
934+
/// @param funcInfo output of FunctionInfo for the function in question
935+
/// @param lineNo line number relative to the function definition
936+
/// set to -1 to return lines before the procedure that are not part of the preceding macro or function
937+
/// see `DisplayHelpTopic("ProcedureText")`
938+
///
939+
/// @returns lines of code from a function inside a procedure file
940940
Function/S getFunctionLine(lineNo, funcInfo)
941941
variable lineNo
942942
string funcInfo

0 commit comments

Comments
 (0)