[introspection-doc-generator] Tidy up API - bit more documentation

[Alan Knowles <alank src gnome org>]

commit f5368fbecd3bd2eb512791b8deac74ab0d5685f2
Author: Alan Knowles <alan akkbhome com>
Date:   Tue Jun 22 22:17:06 2010 +0800

    Tidy up API - bit more documentation

 File.js |   55 +++++++++++++++++++++++++++++++++++++++++--------------
 1 files changed, 41 insertions(+), 14 deletions(-)
---
diff --git a/File.js b/File.js
index 29cff4a..a704c9e 100755
--- a/File.js
+++ b/File.js
@@ -88,6 +88,7 @@ var File = {
         var can = f.resolve_relative_path('');
         return can.get_path();
     },
+    
     /**
      * write
      * @arg path {String} File to write to
@@ -126,25 +127,51 @@ var File = {
         var f = Gio.file_new_for_path(String(path));
         return f['delete']();
     },
-    // copy files recursively from fromDir, silently ignore them if they already exist in toDir
-    silentRecursiveCopy : function (fromDir, toDir) {
+    /**
+     * silentRecursiveCopy
+     * copy files recursively from fromDir, silently ignore them if they already exist in toDir
+     *        unless you select overwrite..
+     * @arg {String} src source path
+     * @arg {String} dest destination path
+     * @arg {Gio.FileCopyFlags} options (optional)  - use Gio.FileCopyFlags.OVERWRITE to 
+     *      otherwise they will not be copied
+     * 
+     */
+    silentRecursiveCopy : function (fromDir, toDir, opts) {
+        
         var filesToCopy = File.recursiveListing(fromDir);
         var srcPath, destPath, src, dest;
-
+        if (typeof(opts) =='undefined') {
+            opts = Gio.FileCopyFlags.NONE;
+        }
+        
         for (var index in filesToCopy) {
-          srcPath = File.join(String(fromDir), filesToCopy[index]);
-          destPath = File.join(String(toDir), filesToCopy[index]);
-
-          if (File.isFile(srcPath) && !File.isFile(destPath)) {
-            File.copyFile(srcPath, destPath);
-          }
-          else if (File.isDirectory(srcPath) && !File.isDirectory(destPath)) {
-            File.mkdir(destPath);
-          }
+            srcPath = File.join(String(fromDir), filesToCopy[index]);
+            destPath = File.join(String(toDir), filesToCopy[index]);
 
+            if (File.isDirectory(srcPath) && !File.isDirectory(destPath)) {
+                File.mkdir(destPath);
+                continue;
+            }
+            // source is not file..?!?!?
+            if (!File.isFile(srcPath)) {
+                continue;
+            }
+            if (File.isFile(destPath) && opts == Gio.FileCopyFlags.NONE) {
+                // do not overwrite.. - if file exists and we are not flaged to overwrite.
+                continue;
+            }
+            
+            File.copyFile(srcPath, destPath, opts);
+           
         }
     },
-
+    
+    /**
+     * mkdir
+     * make a directory..
+     * @arg {String} dstPath directory to make
+     */
     mkdir : function (destPath) {
         var dest = Gio.file_new_for_path(String(destPath));
         return dest.make_directory(null, null);
@@ -158,7 +185,7 @@ var File = {
      */
     copyFile : function (srcPath, destPath, opts) {
         if (typeof(opts) =='undefined') {
-            opts = Gio.FileCopyFlags.NONE
+            opts = Gio.FileCopyFlags.NONE;
         }
         var dest = Gio.file_new_for_path(String(destPath));
         var src = Gio.file_new_for_path(String(srcPath));