Fixed jsDoc, wrapping, newlines

zspitz · zspitz · commit b7bcdde18c1d · 2015-04-13T21:35:59.000+03:00
diff --git a/src/lib/scriptHost.d.ts b/src/lib/scriptHost.d.ts
@@ -27,7 +27,8 @@ interface TextStreamBase {
     Line: number;
     /**
      * Closes a text stream.
-     * It is not necessary to close standard streams; they close automatically when the process ends. If you close a standard stream, be aware that any other pointers to that standard stream become invalid.
+     * It is not necessary to close standard streams; they close automatically when the process ends. If 
+     * you close a standard stream, be aware that any other pointers to that standard stream become invalid.
      */
     Close(): void;
 }
@@ -49,7 +50,7 @@ interface TextStreamWriter extends TextStreamBase {
 
 interface TextStreamReader extends TextStreamBase {
     /**
-     * Returns a specified number of characters from an input stream, beginning at the current pointer position.
+     * Returns a specified number of characters from an input stream, starting at the current pointer position.
      * Does not return until the ENTER key is pressed.
      * Can only be used on a stream in reading mode; causes an error in writing or appending mode.
      */
@@ -88,7 +89,8 @@ interface TextStreamReader extends TextStreamBase {
 
 declare var WScript: {
     /**
-    * Outputs text to either a message box (under WScript.exe) or the command console window followed by a newline (under CScript.ext).
+    * Outputs text to either a message box (under WScript.exe) or the command console window followed by
+    * a newline (under CScript.ext).
     */
     Echo(s: any): void;
     /**
@@ -159,7 +161,8 @@ declare var WScript: {
     DisconnectObject(obj: any): void;
     /**
      * Retrieves an existing object with the specified ProgID from memory, or creates a new one from a file.
-     * @param strPathname Fully qualified path to the file containing the object persisted to disk. For objects in memory, pass a zero-length string.
+     * @param strPathname Fully qualified path to the file containing the object persisted to disk.
+     * For objects in memory, pass a zero-length string.
      * @param strProgID
      * @param strPrefix Function names in the form prefix_event will be bound to this object's COM events.
      */
@@ -171,63 +174,78 @@ declare var WScript: {
     Sleep(intTime: number): void;
 };
 
-/*
- * Allows enumerating over a COM collection, which may not have indexed item access
+/**
+ * Allows enumerating over a COM collection, which may not have indexed item access.
  */
 interface Enumerator<T> {
-    /*
-     * Returns true if the current item is the last one in the collection, or the collection is empty, or the current item is undefined
+    /**
+     * Returns true if the current item is the last one in the collection, or the collection is empty,
+     * or the current item is undefined.
      */
     atEnd(): boolean;
-    /*
+
+    /**
      * Returns the current item in the collection
      */
     item(): T;
-    /*
-     * Resets the current item in the collection to the first item. If there are no items in the collection, the current item is set to undefined.
+
+    /**
+     * Resets the current item in the collection to the first item. If there are no items in the collection,
+     * the current item is set to undefined.
      */
     moveFirst(): void;
-    /*
-     * Moves the current item to the next item in the collection. If the enumerator is at the end of the collection or the collection is empty, the current item is set to undefined.
+
+    /**
+     * Moves the current item to the next item in the collection. If the enumerator is at the end of
+     * the collection or the collection is empty, the current item is set to undefined.
      */
     moveNext(): void;
 }
+
 interface EnumeratorConstructor {
     new <T>(collection: any): Enumerator<T>;
     new (collection: any): Enumerator<any>;
 }
+
 declare var Enumerator: EnumeratorConstructor;
 
-/*
- * Enables reading from a COM safe array, which might have an alternate lower bound, or multiple dimensions
+/**
+ * Enables reading from a COM safe array, which might have an alternate lower bound, or multiple dimensions.
  */
 interface VBArray<T> {
-    /*
+    /**
      * Returns the number of dimensions (1-based).
      */
     dimensions(): number;
-    /*
+
+    /**
      * Takes an index for each dimension in the array, and returns the item at the corresponding location.
      */
     getItem(dimension1Index: number, ...dimensionNIndexes: number[]): T;
-    /*
-     * Returns the smallest available index for a given dimension
+
+    /**
+     * Returns the smallest available index for a given dimension.
      * @param dimension 1-based dimension (defaults to 1)
      */
     lbound(dimension?: number): number;
-    /*
-     * Returns the largest available index for a given dimension
+
+    /**
+     * Returns the largest available index for a given dimension.
      * @param dimension 1-based dimension (defaults to 1)
      */
     ubound(dimension?: number): number;
-    /*
-     * Returns a Javascript array with all the elements in the VBArray. If there are multiple dimensions, each successive dimension is appended to the end of the array.
-     * [[1,2,3],[4,5,6]] => [1,2,3,4,5,6]
+
+    /**
+     * Returns a Javascript array with all the elements in the VBArray. If there are multiple dimensions,
+     * each successive dimension is appended to the end of the array.
+     * Example: [[1,2,3],[4,5,6]] becomes [1,2,3,4,5,6]
      */
     toArray(): T[];
 }
+
 interface VBArrayConstructor {
     new <T>(safeArray: any): VBArray<T>;
     new (safeArray: any): VBArray<any>;
 }
-declare var VBArray: VBArrayConstructor;
+
+declare var VBArray: VBArrayConstructor;
