Added @author tags to each module.

This commit is contained in:
Bram van der Veen 2015-08-16 13:48:08 +02:00
parent c2c9d215f7
commit 091440cd2a
11 changed files with 12 additions and 1 deletions

1
api.js
View file

@ -3,6 +3,7 @@
* Module for handling API requests.
* API is able to be called through /api/:apirequest?=arguments
* @module api
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Importing self-written modules.

View file

@ -2,6 +2,7 @@
/**
* Module for handling the Authentication in the web application.
* @module auth
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Importing first and third-party modules.

View file

@ -2,6 +2,7 @@
/**
* Module for the return/creating of a settings file/object.
* @module configuration
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Import first-party modules.

View file

@ -2,6 +2,7 @@
/**
* Module for encrypting and decrypting strings.
* @module crypt
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Import first-party modules.
@ -34,7 +35,7 @@ function encrypt(str) {
/**
* Function to decrypt a string.
* @param {String} str - String you want to decrypt
* @return {String} The decrypted string.
* @return {String} The decrypted string.
*/
function decrypt(str) {
var decryptArray = [];

View file

@ -3,6 +3,7 @@
* Module for using a database interface
* Either local (NeDB) or remote (MongoDB) based on configuration values.
* @module database
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Import first-party modules.

View file

@ -2,6 +2,7 @@
/**
* Module for handling lookup requests by the user supplied search query.
* @module lookup
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Importing first-party modules.

View file

@ -2,6 +2,7 @@
/**
* Module for redirecting the user based on what they typed into search.
* @module redirecter
* @author Bram van der Veen <96aa48@gmail.com>
*/

View file

@ -3,6 +3,7 @@
* Module for parsing downloaded schedule pages into useable/readable JSON objects.
* Usually used after a lookup with the supplied information from it.
* @module schedule
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Import first-party modules.

View file

@ -3,6 +3,7 @@
* Module/script for getting students, teachers, chambers and groups from the schedule website.
* This script needs to be run before using the application, as the website will have no information to run on.
* @module spider
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Import first-party modules.

View file

@ -4,6 +4,7 @@
* Used for adding frontend features like showing what hour it currently is or
* changing color because the school day is over.
* @module time
* @author Bram van der Veen <96aa48@gmail.com>
*/
//Importing self-written modules.

1
web.js
View file

@ -3,6 +3,7 @@
* Module/script for setting up the web frontend and binding all of the modules
* together.
* @module web
* @author Bram van der Veen <96aa48@gmail.com>
*/