Adds comments ; Updates Readme

Author: acadet

README.md

@@ -1,2 +1,20 @@
 # Ludivine - A TypeScript Boilerplate [![Build Status](https://travis-ci.org/acadet/ludivine.svg?branch=master)](https://travis-ci.org/acadet/ludivine)
 
+Inspired from C#.
+
+# In brief
+
+A great way to start your TS projects. Wraps delicious tools and structures such as:
+
+* Collections
+    - ArrayList, LinkedList, SortedList
+    - Dictionary
+    - Stack
+	- Queue
+* Lambda interfaces
+* Core classes
+    - Timers
+    - Log
+    - Exception
+
+and other fantastic stuff! Feel free to browse the [Wiki](https://github.com/acadet/ludivine/wiki)!

src/Action.ts

@@ -1,21 +1,45 @@
 /// <reference path="ref.ts" />
 
+/**
+ * Actions are shortcuts for typing functions with no outcome
+ */
+
+/**
+ * @class Action0
+ * @brief Action with no args
+ */
 interface Action0 {
 	() : void;
 }
 
+/**
+ * @class Action
+ * @brief Action expecting a single arg
+ */
 interface Action<T> {
 	(t : T) : void;
 }
 
+/**
+ * @class Action2
+ * @brief Action expecting two args
+ */
 interface Action2<T, U> {
 	(t : T, u : U) : void;
 }
 
+/**
+ * @class Action3
+ * @brief Action expecting 3 args
+ */
 interface Action3<T, U, V> {
 	(t : T, u : U, v : V) : void;
 }
 
+/**
+ * @class Action4
+ * @type Action expecting 4 args
+ */
 interface Action4<T, U, V, W> {
 	(t : T, u : U, v : V, w : W) : void;
 }

src/Exception.ts

@@ -1,8 +1,17 @@
 /// <reference path="ref.ts" />
 
+/**
+ * @class Exception
+ * @brief Wraps any error. 
+ * @description User can extend this class to create his custom 
+ * exception.
+ */
 class Exception {
 	//region Fields
 
+	/**
+	 * Wrapped error
+	 */
 	private _error : any;
 
 	//endregion Fields
@@ -24,18 +33,34 @@ class Exception {
 
 	//region Public Methods
 
+	/**
+	 * Gets inner message
+	 * @return {string} Inner message
+	 */
 	getMessage() : string {
 		return this._error.message;
 	}
 
+	/**
+	 * Gets name of exception
+	 * @return {string} Name of exception
+	 */
 	getName() : string {
 		return this._error.name;
 	}
 
+	/**
+	 * Gets stack trace
+	 * @return {string} Stack trace
+	 */
 	getStackTrace() : string  {
 		return this._error.stack;
 	}
 
+	/**
+	 * Stringifies error
+	 * @return {string} [description]
+	 */
 	toString() : string {
 		return this._error.name + ': ' + this._error.message;
 	}

src/Func.ts

@@ -1,21 +1,45 @@
 /// <reference path="ref.ts" />
 
+/**
+ * Shortcuts for typing functions
+ */
+
+/**
+ * @class Func0
+ * @brief Function with no args 
+ */
 interface Func0<U> {
 	() : U;
 }
 
+/**
+ * @class Func
+ * @brief Function expecting a single arg
+ */
 interface Func<T, U> {
 	(t: T) : U;
 }
 
+/**
+ * @class Func2
+ * @brief Function expecting 2 args
+ */
 interface Func2<T, U, V> {
 	(t : T, u : U) : V;
 }
 
+/**
+ * @class Func3
+ * @brief Function expecting 3 args
+ */
 interface Func3<T, U, V, W> {
 	(t : T, u : U, v : V) : W
 }
 
+/**
+ * @class Func4
+ * @brief Function expecting 4 args
+ */
 interface Func4<T, U, V, W, X> {
 	(t : T, u : U, v : V, w : W) : X
 }

src/Guid.ts

@@ -1,5 +1,9 @@
 /// <reference path="ref.ts" />
 
+/**
+ * @class Guid
+ * @brief Procudes unique Guid
+ */
 class Guid {
 	//region Fields
 
@@ -13,14 +17,19 @@ class Guid {
 
 	//region Private Methods
 
+	/**
+	 * Returns a random string using provided charset
+	 * @param  {number} length Desired length
+	 * @return {string}        Random string
+	 */
 	static _randomString(length : number) : string {
 		if (length < 1) {
 			return null;
 		} else {
 			var charSet : string = 'ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789';
 			var outcome : string = '';
 
-			for(var i = 0; i < length; i++) {
+			for (var i = 0; i < length; i++) {
 				var index : number;
 
 				index = Math.floor(Math.random() * charSet.length);
@@ -35,6 +44,10 @@ class Guid {
 
 	//region Public Methods
 
+	/**
+	 * Produces a new guid
+	 * @return {string} [description]
+	 */
 	static newGuid() : string {
 		var outcome : StringBuffer;
 

src/KeyValuePair.ts

@@ -1,16 +1,32 @@
 /// <reference path="ref.ts" />
 
+/**
+ * @class KeyValuePair
+ * @brief Pairs key and value
+ */
 class KeyValuePair<T, U> {
 	//region Fields
 
+	/**
+	 * Inner key
+	 */
 	private _key : T;
+
+	/**
+	 * Inner value
+	 */
 	private _value : U;
 
 	//endregion Fields
 
 	//region Constructors
 
-	constructor(key : T = null, value : U = null) {
+	/**
+	 * Builds a new pair
+	 * @param {T} key   Optional key
+	 * @param {U} value Optional value
+	 */
+	constructor(key? : T, value? : U) {
 		this._key = key;
 		this._value = value;
 	}
@@ -25,18 +41,34 @@ class KeyValuePair<T, U> {
 
 	//region Public Methods
 
+	/**
+	 * Returns key
+	 * @return {T} [description]
+	 */
 	getKey() : T {
 		return this._key;
 	}
 
+	/**
+	 * Sets key
+	 * @param {T} key [description]
+	 */
 	setKey(key : T) : void {
 		this._key = key;
 	}
 
+	/**
+	 * Gets value
+	 * @return {U} [description]
+	 */
 	getValue() : U {
 		return this._value;
 	}
 
+	/**
+	 * Returns value
+	 * @param {U} value [description]
+	 */
 	setValue(value : U) : void {
 		this._value = value;
 	}

src/Log.ts

@@ -0,0 +1,89 @@
+/// <reference path="ref.ts" />
+
+/**
+ * @class LogLevel
+ * @brief Available levels of log
+ */
+enum LogLevel {
+	Debug = 0, // all messages
+	Test = 1, // only inform, warnings & errors
+	Production = 2, // only warnings & erros
+	Opaque = 3 // only errors
+}
+
+/**
+ * @class Log
+ * @brief Simple log
+ */
+class Log {
+	//region Fields	
+
+	/**
+	 * Current level of log. Default value to Debug
+	 */
+	private static _currentLevel : LogLevel = LogLevel.Debug;
+
+	//endregion Fields
+	
+	//region Constructors
+	
+	//endregion Constructors
+	
+	//region Methods
+	
+	//region Private Methods
+
+	//endregion Private Methods
+	
+	//region Public Methods
+	
+	/**
+	 * Sets current level of log
+	 * @param {LogLevel} level Desired level
+	 */
+	static setLevel(level : LogLevel) : void {
+		Log._currentLevel = level;
+	}
+
+	/**
+	 * Prints a debug message
+	 * @param {string} msg Message
+	 */
+	static debug(msg : string) : void {
+		if (this._currentLevel <= LogLevel.Debug) {
+			console.log('DEBUG: ' + msg);
+		}
+	}
+
+	/**
+	 * Prints information
+	 * @param {string} msg Message
+	 */
+	static inform(msg : string) : void {
+		if (this._currentLevel <= LogLevel.Test) {
+			console.log('%cINFORM: ' + msg, 'color: DeepSkyBlue;');
+		}
+	}
+
+	/**
+	 * Prints warning
+	 * @param {string} msg Message
+	 */
+	static warn(msg : string) : void {
+		if (this._currentLevel <= LogLevel.Production) {
+			console.log('%cWARN: ' + msg, 'color: orange;');
+		}
+	}
+
+	/**
+	 * Prints an error
+	 * @param {Exception} error Exception
+	 */
+	static error(error : Exception) : void {
+		console.error('Error: ' + error.toString());
+	}
+
+	//endregion Public Methods
+	
+	//endregion Methods
+}