Document a few more functions.

1 files changed, 9 insertions, 6 deletions

diff --git a/etc/inc/pfsense-utils.inc b/etc/inc/pfsense-utils.inc
index 91ddd04..9289ec4 100644
--- a/etc/inc/pfsense-utils.inc
+++ b/etc/inc/pfsense-utils.inc
@@ -36,20 +36,23 @@
 /****f* pfsense-utils/log_error
  * NAME
  *   log_error - Sends a string to syslog.
+ * INPUTS
+ *   $error	- string containing the syslog message.
  * RESULT
  *   null
  ******/
-
-/*
- * log_error: send string to syslog
- */
 function log_error($error) {
     syslog(LOG_WARNING, $error);
     return;
 }
 
-/*
- * return_dir_as_array($dir): returns $dir contents as an array
+/****f* pfsense-utils/return_dir_as_array
+ * NAME
+ *   return_dir_as_array - Return a directory's contents as an array.
+ * INPUTS
+ *   $dir	- string containing the path to the desired directory.
+ * RESULT
+ *   $dir_array - array containing the directory's contents. This array will be empty in the event of an array.
  */
 function return_dir_as_array($dir) {
     $dir_array = array();