Added class documentation to docs/

JacobMisirian · JacobMisirian · commit 531e336acc1b · 2017-09-07T16:19:54.000-05:00
diff --git a/docs/Crypto/AES.md b/docs/Crypto/AES.md
@@ -1,8 +1,6 @@
 ## class AES
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for encrypting and decrypting lists of bytes and IO.File objects using AES.
 
 #### ```func decryptbytes (key : list, iv : list, dataStrOrList : object) : list```
 
diff --git a/docs/Crypto/RSA.md b/docs/Crypto/RSA.md
@@ -1,8 +1,6 @@
 ## class RSA
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for encrypting and decrypting messages using RSA.
 
 #### ```func decrypt (pubmod : BigInt, privkey : BigInt, msg : object)```
 
diff --git a/docs/Drawing/Bitmap.md b/docs/Drawing/Bitmap.md
@@ -1,5 +1,7 @@
 ## class Bitmap
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a Bitmap object.
+
 #### ```func getpixel (x : int, y : int) : Color```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Returns a new Drawing.Color object with the value of the pixel at the specified x and y coordinates.
diff --git a/docs/Drawing/Color.md b/docs/Drawing/Color.md
@@ -1,5 +1,7 @@
 ## class Color
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a Color object.
+
 #### ```a { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly alpha value.
diff --git a/docs/IO/DirectoryNotFoundException.md b/docs/IO/DirectoryNotFoundException.md
@@ -1,5 +1,7 @@
 ## class DirectoryNotFoundException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception thrown when a directory is not found.
+
 #### ```func new (path : str) : DirectoryNotFoundException```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Constructs a new DirectoryNotFoundException using the specified path.
diff --git a/docs/IO/FS.md b/docs/IO/FS.md
@@ -1,8 +1,6 @@
 ## class FS
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for interacting with the filesystem.
 
 #### ```func close (file : File) : null```
 
diff --git a/docs/IO/File.md b/docs/IO/File.md
@@ -1,5 +1,7 @@
 ## class File
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a File object.
+
 #### ```abspath { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly absolute path string.
diff --git a/docs/IO/FileClosedException.md b/docs/IO/FileClosedException.md
@@ -1,5 +1,7 @@
 ## class FileClosedException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when an IO.File object's stream has been closed.
+
 #### ```file { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly IO.File object that has been closed.
diff --git a/docs/IO/FileNotFoundException.md b/docs/IO/FileNotFoundException.md
@@ -1,5 +1,7 @@
 ## class FileNotFoundException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when a file is not found.
+
 #### ```func new (path : string) : FileNotFoundException```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Constructs a new FileNotFoundException object using the specified path.
diff --git a/docs/IO/Path.md b/docs/IO/Path.md
@@ -1,8 +1,6 @@
 ## class Path
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for interacting with path strings.
 
 #### ```func combine (params paths) : string```
 
diff --git a/docs/Math/Math.md b/docs/Math/Math.md
@@ -1,8 +1,6 @@
 ## class Math
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for advanced mathematical operations.
 
 #### ```func abs (num : number) : float```
 
diff --git a/docs/Math/Random.md b/docs/Math/Random.md
@@ -1,5 +1,7 @@
 ## class Random
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a Random object for computing pseudo-random numbers.
+
 #### ```func new () : Random```
 
 #### ```func new (seed : int) : Random```
diff --git a/docs/Net/DNS.md b/docs/Net/DNS.md
@@ -1,8 +1,6 @@
 ## class DNS
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class containing methods for resolving IP addresses and hostnames through the DNS protocol.
 
 #### ```func gethost (IPAddrOrStr : object) : string```
 
diff --git a/docs/Net/IPAddr.md b/docs/Net/IPAddr.md
@@ -1,5 +1,7 @@
 ## class IPAddr
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```address { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly string ip address.
diff --git a/docs/Net/Socket.md b/docs/Net/Socket.md
@@ -1,5 +1,7 @@
 ## class Socket
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```autoflush { get; }```
 
 #### ```autofluah { set; }```
diff --git a/docs/Net/SocketClosedException.md b/docs/Net/SocketClosedException.md
@@ -1,5 +1,7 @@
 ## class SocketClosedException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func new (sock : Socket) : SocketClosedException```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Constructs a new SocketClosedException using the specified Net.Socket object.
diff --git a/docs/Net/SocketListener.md b/docs/Net/SocketListener.md
@@ -1,5 +1,7 @@
 ## class SocketListener
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func acceptsock () : Socket```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Hangs until a new connection has been received and returns a Net.Socket object of that client.
diff --git a/docs/Net/Web.md b/docs/Net/Web.md
@@ -1,5 +1,7 @@
 ## class Web
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func downloaddata (url : string) : list```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Downloads bytes from the specified url and returns them in a list.
diff --git a/docs/Text/Encoding.md b/docs/Text/Encoding.md
@@ -1,5 +1,7 @@
 ## class Encoding
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```bodyname { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly string body name of this encoding.
diff --git a/docs/Text/StringBuilder.md b/docs/Text/StringBuilder.md
@@ -1,5 +1,7 @@
 ## class StringBuilder
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func new () : StringBuilder```
 
 #### ```func new (obj : object) : StringBuilder```
diff --git a/docs/Types/ArgLengthException.md b/docs/Types/ArgLengthException.md
@@ -1,5 +1,7 @@
 ## class ArgLengthException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when an argument length does not match the desired length.
+
 #### ```expected { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly int representing how many args were expected.
diff --git a/docs/Types/AttribNotFoundException.md b/docs/Types/AttribNotFoundException.md
@@ -1,5 +1,7 @@
 ## class AttribNotFoundException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when an attribute is not found within an object.
+
 #### ```attribute { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly string attribute that was not found.
diff --git a/docs/Types/BigInt.md b/docs/Types/BigInt.md
@@ -1,5 +1,7 @@
 ## class BigInt
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a variable length integer represented with a list of bytes.
+
 #### ```func tostring () : string```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Converts this BigInt to a string and returns it.
diff --git a/docs/Types/ConversionFailedException.md b/docs/Types/ConversionFailedException.md
@@ -1,26 +1,4 @@
 ## class ConversionFailedException
 
-#### ```desired { get; }```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```func new (obj : object, type : object) : ConversionFailedException```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```message { get; }```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```func tostring () : string```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown if a type conversion fails.
 
diff --git a/docs/Types/IndexOutOfRangeException.md b/docs/Types/IndexOutOfRangeException.md
@@ -1,5 +1,7 @@
 ## class IndexOutOfRangeException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown if an index is out of the range of an object.
+
 #### ```index { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly integer index that was out of range.
diff --git a/docs/Types/KeyNotFoundException.md b/docs/Types/KeyNotFoundException.md
@@ -1,5 +1,7 @@
 ## class KeyNotFoundException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when a key is not found in an object.
+
 #### ```func new (obj : object, key : object) : KeyNotFoundException```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Constructs a new KeyNotFoundException object using the specified object and key.
diff --git a/docs/Types/PrivateAttribException.md b/docs/Types/PrivateAttribException.md
@@ -1,32 +1,4 @@
 ## class PrivateAttribException
 
-#### ```attrib { get; }```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```func new (obj : object, attrib : string) : PrivateAttribException```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```message { get; }```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```object { get; }```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
-#### ```func tostring () : string```
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
-
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown if an attempt is made to access a private attribute.
 
diff --git a/docs/Types/Thread.md b/docs/Types/Thread.md
@@ -1,5 +1,7 @@
 ## class Thread
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a separate thread from the main entry point.
+
 #### ```isalive { get; }```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Gets the readonly bool representing if this thread is currently running.
diff --git a/docs/Types/VariableNotFoundException.md b/docs/Types/VariableNotFoundException.md
@@ -1,5 +1,7 @@
 ## class VariableNotFoundException
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing an exception that is thrown when a variable is not found inside of the stack frame.
+
 #### ```func new () : VariableNotFoundException```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Constructs a new VariableNotFoundException.
diff --git a/docs/Types/bool.md b/docs/Types/bool.md
@@ -1,5 +1,7 @@
 ## class bool
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a boolean that is either true or false.
+
 #### ```func __equals__ (b : bool) : bool```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Implements the == operator to determine if this bool is equal to the specified bool.
diff --git a/docs/Types/char.md b/docs/Types/char.md
@@ -1,5 +1,7 @@
 ## class char
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a byte-sized character.
+
 #### ```func __add__ (c : char) : char```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Implements the + operator to add to this char.
diff --git a/docs/Types/dict.md b/docs/Types/dict.md
@@ -1,5 +1,7 @@
 ## class dict
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a dictionary where the keys and values are objects.
+
 #### ```func add (key : object, val : object) : null```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Adds the given value to the dictionary under the specified key.
diff --git a/docs/Types/false.md b/docs/Types/false.md
@@ -1,5 +1,7 @@
 ## class false
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func __equals__ (b : bool) : bool```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Implements the == operator to determine if this bool is equal to the specified bool.
diff --git a/docs/Types/float.md b/docs/Types/float.md
@@ -1,5 +1,7 @@
 ## class float
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a double-precision floating point number.
+
 #### ```func __add__ (num : number) : float```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Implements the + operator, adding this float to the specified number.
diff --git a/docs/Types/func.md b/docs/Types/func.md
@@ -2,5 +2,3 @@
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
diff --git a/docs/Types/globals.md b/docs/Types/globals.md
@@ -1,5 +1,7 @@
 ## class globals
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
 #### ```func clone (obj : object) : object```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Creates a clone of the given object.
diff --git a/docs/Types/int.md b/docs/Types/int.md
@@ -1,5 +1,7 @@
 ## class int
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a 64-bit integer.
+
 #### ```func __add__ (num : number) : number```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Implements the + operator, adding this int to the specified number.
diff --git a/docs/Types/list.md b/docs/Types/list.md
@@ -1,5 +1,7 @@
 ## class list
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class representing a variable length list of objects.
+
 #### ```func add (obj : object) : null```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Adds the specified object to this list.
diff --git a/docs/Types/module.md b/docs/Types/module.md
@@ -2,5 +2,3 @@
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
diff --git a/docs/Types/null.md b/docs/Types/null.md
@@ -1,2 +1,4 @@
 ## class null
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
+
diff --git a/docs/Types/number.md b/docs/Types/number.md
@@ -2,5 +2,3 @@
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
diff --git a/docs/Types/object.md b/docs/Types/object.md
@@ -2,5 +2,3 @@
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
diff --git a/docs/Types/property.md b/docs/Types/property.md
@@ -2,5 +2,3 @@
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` 
 
-&nbsp;&nbsp;&nbsp;&nbsp;```@returns:``` 
-
diff --git a/docs/Types/string.md b/docs/Types/string.md
@@ -1,5 +1,7 @@
 ## class string
 
+&nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` @desc A class represneting an array of characters.
+
 #### ```func tostring () : string```
 
 &nbsp;&nbsp;&nbsp;&nbsp;```@desc:``` Returns this string.
diff --git a/docs/Types/true.md b/docs/Types/true.md
diff --git a/docs/Types/tuple.md b/docs/Types/tuple.md
diff --git a/docs/Types/typedef.md b/docs/Types/typedef.md
diff --git a/docs/Util/ColorNotFoundException.md b/docs/Util/ColorNotFoundException.md
diff --git a/docs/Util/DateTime.md b/docs/Util/DateTime.md
diff --git a/docs/Util/OS.md b/docs/Util/OS.md
diff --git a/docs/Util/Process.md b/docs/Util/Process.md
diff --git a/docs/Util/StopWatch.md b/docs/Util/StopWatch.md
diff --git a/docs/Util/UI.md b/docs/Util/UI.md
diff --git a/docs/docs.has b/docs/docs.has
diff --git a/docs/globals.md b/docs/globals.md
