[geeklog-cvs] geeklog: Document links_select_box

[geeklog-cvs at lists.geeklog.net]

changeset 7775:db2483e27c6a
url:  http://project.geeklog.net/cgi-bin/hgwebdir.cgi/geeklog/rev/db2483e27c6a
user: Dirk Haun <Dirk.Haun at compart.net>
date: Wed Mar 10 10:16:40 2010 +0100
description:
Document links_select_box

diffstat:

 plugins/links/functions.inc |  15 ++++++++++++---
 1 files changed, 12 insertions(+), 3 deletions(-)

diffs (31 lines):

diff -r b62e11b8d65b -r db2483e27c6a plugins/links/functions.inc
--- a/plugins/links/functions.inc	Tue Mar 09 19:07:03 2010 -0500
+++ b/plugins/links/functions.inc	Wed Mar 10 10:16:40 2010 +0100
@@ -1256,15 +1256,24 @@
 
 /*
 * Build selection list
+*
+* @param    int     $access access permissions (3 = read/edit, 2 = read only)
+* @param    string  $sel    current selection
+* @return   string          HTML for select list
+*
 */
-function links_select_box ($access, $sel = '')
+function links_select_box($access, $sel = '')
 {
     global $_CONF, $LANG_LINKS, $_LI_CONF;
 
     // set root value
-    $menu = '<option value="' . $_LI_CONF['root'] . '">' . $LANG_LINKS['root'] . '</option>';
+    $menu = '<option value="' . $_LI_CONF['root'] . '">' . $LANG_LINKS['root']
+          . '</option>';
+
     // get option values
-    $list = links_select_box_recursive($menu, $_LI_CONF['root'], $sel, '  ', $access);
+    $list = links_select_box_recursive($menu, $_LI_CONF['root'], $sel,
+                                       '  ', $access);
+
     // return list of options
     return $list;
 }