Skip to content

Commit 1fefaa6

Browse files
author
Matthias Kastner
committed
Coding Guidelines and Doxygen
remove ws error and add doxygen parameter description to function.
1 parent 4ac3d4c commit 1fefaa6

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

procedures/CodeBrowser_gui.ipf

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -211,11 +211,13 @@ End
211211
// Returns the currently selected item from the panel defined by the optional arguments.
212212
// Exactly one optional argument must be given.
213213
//
214-
// module: Module from ProcGlobal/Independent Module list
215-
// procedure: "myProcedure.ipf [moduleName]"
216-
// procedureWithModule: "myProcedure.ipf"
217-
// index: Zero-based index into main listbox
218-
Function/S getCurrentItem([module, procedure,procedureWithoutModule, index])
214+
// @param module: Module from ProcGlobal/Independent Module list
215+
// @param procedure: "myProcedure.ipf [moduleName]"
216+
// @param procedureWithModule: "myProcedure.ipf"
217+
// @param index: Zero-based index into main listbox
218+
//
219+
// @returns the currently selected item
220+
Function/S getCurrentItem([module, procedure, procedureWithoutModule, index])
219221
variable module, procedureWithoutModule, procedure, index
220222

221223
string procName
@@ -304,7 +306,7 @@ Function getCurrentItemAsNumeric([module, procedure, index, indexTop])
304306
return -1 // error
305307
End
306308

307-
// Updates the the given popup menu
309+
// Updates the given popup menu
308310
// Tries to preserve the currently selected item
309311
Function updatePopup(ctrlName)
310312
string ctrlName
@@ -320,7 +322,7 @@ Function updatePopup(ctrlName)
320322

321323
ControlUpdate/W=$panel $ctrlName
322324

323-
list = GetUserData(panel,procCtrl,userDataNiceList)
325+
list = GetUserData(panel, procCtrl, userDataNiceList)
324326

325327
if(ItemsInList(list) == 1)
326328
PopupMenu $ctrlName win=$panel, disable=2
@@ -329,10 +331,10 @@ Function updatePopup(ctrlName)
329331
endif
330332

331333
// try to restore the previously selected item if it differs from the current one
332-
variable newIndex = WhichListItem(itemText,list) + 1
334+
variable newIndex = WhichListItem(itemText, list) + 1
333335

334336
if(newIndex != index) // only update if required, as the update triggers the list generating function
335-
if( newIndex > 0)
337+
if(newIndex > 0)
336338
PopupMenu $ctrlName win=$panel, mode=newIndex
337339
else
338340
PopupMenu $ctrlName win=$panel, mode=1

0 commit comments

Comments
 (0)