function piper() commented

git-svn-id: file:///svnroot/renrot/trunk@534 fe2816f4-e837-0410-b10a-f608c9d244a1

1 files changed, 8 insertions, 3 deletions

diff --git a/renrot b/renrot
index dae35c5..8d783b0 100755
--- a/renrot
+++ b/renrot
@@ -1889,9 +1889,14 @@ sub thm_gen_orig {
 
 
 ########################################################################################
-#
-# piper() opens two pipes for process object via cmd
-#
+# Usage      : piper();
+# Purpose    : opens two pipes for process object via the command passed as argument
+# Returns    : $pipe_obj processed via $pipe_cmd
+# Parameters : $pipe_obj bin - the object to be processed via pipe
+#            : $pipe_cmd str - the command for the processing
+# Throws     : no exceptions
+# Comments   : none
+# See Also   : n/a
 sub piper {
   use FileHandle;
   use IPC::Open2;