Skip to content

Commit 55a1509

Browse files
committed
Added class documentation to docs/
1 parent 531e336 commit 55a1509

37 files changed

+38
-37
lines changed

docs/Crypto/AES.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class AES
22

3-
    ```@desc:``` @desc A class containing methods for encrypting and decrypting lists of bytes and IO.File objects using AES.
3+
    ```@desc:``` A class containing methods for encrypting and decrypting lists of bytes and IO.File objects using AES.
44

55
#### ```func decryptbytes (key : list, iv : list, dataStrOrList : object) : list```
66

docs/Crypto/RSA.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class RSA
22

3-
    ```@desc:``` @desc A class containing methods for encrypting and decrypting messages using RSA.
3+
    ```@desc:``` A class containing methods for encrypting and decrypting messages using RSA.
44

55
#### ```func decrypt (pubmod : BigInt, privkey : BigInt, msg : object)```
66

docs/Drawing/Bitmap.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class Bitmap
22

3-
    ```@desc:``` @desc A class representing a Bitmap object.
3+
    ```@desc:``` A class representing a Bitmap object.
44

55
#### ```func getpixel (x : int, y : int) : Color```
66

docs/Drawing/Color.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class Color
22

3-
    ```@desc:``` @desc A class representing a Color object.
3+
    ```@desc:``` A class representing a Color object.
44

55
#### ```a { get; }```
66

docs/IO/DirectoryNotFoundException.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class DirectoryNotFoundException
22

3-
    ```@desc:``` @desc A class representing an exception thrown when a directory is not found.
3+
    ```@desc:``` A class representing an exception thrown when a directory is not found.
44

55
#### ```func new (path : str) : DirectoryNotFoundException```
66

docs/IO/FS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class FS
22

3-
    ```@desc:``` @desc A class containing methods for interacting with the filesystem.
3+
    ```@desc:``` A class containing methods for interacting with the filesystem.
44

55
#### ```func close (file : File) : null```
66

docs/IO/File.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class File
22

3-
    ```@desc:``` @desc A class representing a File object.
3+
    ```@desc:``` A class representing a File object.
44

55
#### ```abspath { get; }```
66

docs/IO/FileClosedException.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class FileClosedException
22

3-
    ```@desc:``` @desc A class representing an exception that is thrown when an IO.File object's stream has been closed.
3+
    ```@desc:``` A class representing an exception that is thrown when an IO.File object's stream has been closed.
44

55
#### ```file { get; }```
66

docs/IO/FileNotFoundException.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class FileNotFoundException
22

3-
    ```@desc:``` @desc A class representing an exception that is thrown when a file is not found.
3+
    ```@desc:``` A class representing an exception that is thrown when a file is not found.
44

55
#### ```func new (path : string) : FileNotFoundException```
66

docs/IO/Path.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
## class Path
22

3-
    ```@desc:``` @desc A class containing methods for interacting with path strings.
3+
    ```@desc:``` A class containing methods for interacting with path strings.
44

55
#### ```func combine (params paths) : string```
66

0 commit comments

Comments
 (0)