Added @author tags to each module.
This commit is contained in:
parent
c2c9d215f7
commit
091440cd2a
1
api.js
1
api.js
|
@ -3,6 +3,7 @@
|
||||||
* Module for handling API requests.
|
* Module for handling API requests.
|
||||||
* API is able to be called through /api/:apirequest?=arguments
|
* API is able to be called through /api/:apirequest?=arguments
|
||||||
* @module api
|
* @module api
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Importing self-written modules.
|
//Importing self-written modules.
|
||||||
|
|
1
auth.js
1
auth.js
|
@ -2,6 +2,7 @@
|
||||||
/**
|
/**
|
||||||
* Module for handling the Authentication in the web application.
|
* Module for handling the Authentication in the web application.
|
||||||
* @module auth
|
* @module auth
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Importing first and third-party modules.
|
//Importing first and third-party modules.
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
/**
|
/**
|
||||||
* Module for the return/creating of a settings file/object.
|
* Module for the return/creating of a settings file/object.
|
||||||
* @module configuration
|
* @module configuration
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Import first-party modules.
|
//Import first-party modules.
|
||||||
|
|
1
crypt.js
1
crypt.js
|
@ -2,6 +2,7 @@
|
||||||
/**
|
/**
|
||||||
* Module for encrypting and decrypting strings.
|
* Module for encrypting and decrypting strings.
|
||||||
* @module crypt
|
* @module crypt
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Import first-party modules.
|
//Import first-party modules.
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
* Module for using a database interface
|
* Module for using a database interface
|
||||||
* Either local (NeDB) or remote (MongoDB) based on configuration values.
|
* Either local (NeDB) or remote (MongoDB) based on configuration values.
|
||||||
* @module database
|
* @module database
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Import first-party modules.
|
//Import first-party modules.
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
/**
|
/**
|
||||||
* Module for handling lookup requests by the user supplied search query.
|
* Module for handling lookup requests by the user supplied search query.
|
||||||
* @module lookup
|
* @module lookup
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Importing first-party modules.
|
//Importing first-party modules.
|
||||||
|
|
|
@ -2,6 +2,7 @@
|
||||||
/**
|
/**
|
||||||
* Module for redirecting the user based on what they typed into search.
|
* Module for redirecting the user based on what they typed into search.
|
||||||
* @module redirecter
|
* @module redirecter
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
* Module for parsing downloaded schedule pages into useable/readable JSON objects.
|
* Module for parsing downloaded schedule pages into useable/readable JSON objects.
|
||||||
* Usually used after a lookup with the supplied information from it.
|
* Usually used after a lookup with the supplied information from it.
|
||||||
* @module schedule
|
* @module schedule
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Import first-party modules.
|
//Import first-party modules.
|
||||||
|
|
|
@ -3,6 +3,7 @@
|
||||||
* Module/script for getting students, teachers, chambers and groups from the schedule website.
|
* 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.
|
* This script needs to be run before using the application, as the website will have no information to run on.
|
||||||
* @module spider
|
* @module spider
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Import first-party modules.
|
//Import first-party modules.
|
||||||
|
|
1
time.js
1
time.js
|
@ -4,6 +4,7 @@
|
||||||
* Used for adding frontend features like showing what hour it currently is or
|
* Used for adding frontend features like showing what hour it currently is or
|
||||||
* changing color because the school day is over.
|
* changing color because the school day is over.
|
||||||
* @module time
|
* @module time
|
||||||
|
* @author Bram van der Veen <96aa48@gmail.com>
|
||||||
*/
|
*/
|
||||||
|
|
||||||
//Importing self-written modules.
|
//Importing self-written modules.
|
||||||
|
|
Loading…
Reference in a new issue