Commit fc0d3743 authored by Mark Stenglein's avatar Mark Stenglein

update headers on files to make them more descriptive

parent 90141ab1
Pipeline #687 failed with stage
in 42 seconds
// Mason SRCT: Schedules Application Main File
// - This is the main file for the schedules app, which loads in all of the
// configuration and routing files. Essentially, any other file eventually
// leads here.
// - Take care with this file, it can hurt if you mess it up.
/*
* Mason SRCT: Schedules Application Main File
* - This is the main file for the schedules app, which loads in all of the
* configuration and routing files. Essentially, any other file eventually
* leads here.
* - Take care with this file, it can hurt if you mess it up.
*/
// Load in the different packages
require('app-module-path').addPath(__dirname)
......
// ////////////////////////////////////////////////////////////////////////////
// Mason SRCT: Schedules API v1
// - This API supports the Schedules project at schedules.gmu.edu as the backend
// data source for the application sent on the front end.
// ////////////////////////////////////////////////////////////////////////////
/*
* Schedules by Student Run Computing and Technology
*
* routes/api/v1.js
*
* This API supports the Schedules project at schedules.gmu.edu as the backend
* data source for the application as well as any other third party apps.
*
* iCal Generation is handled on a separate file.
*/
var express = require('express')
var router = express.Router()
......
// //////////////////////////////////////////////////////////////////////////////
// Mason SRCT: Schedules Documentation Routes
// - This routing file is for the documentation behind the scheduels app
// - Most of these should really just be basic render functions without anything
// more complex that that.
// //////////////////////////////////////////////////////////////////////////////
/*
* Schedules by Student Run Computing and Technology
*
* routes/docs.js
*
* This routing file is for the documentation behind the application.
*
* Most of these should be basic renders of static templates that don't change.
*
* TODO: Look into just having these served by nginx on it's own?
*/
var express = require('express')
var router = express.Router()
var config = require('config')
......
// //////////////////////////////////////////////////////////////////////////////
// Mason SRCT: Schedules Main App Routes
// - This routing file describes the main front-end's routing.
// - This serves the root page as well as parses preset url's generated by the
// application
// //////////////////////////////////////////////////////////////////////////////
/*
* Schedules by Student Run Computing and Technology
*
* routes/index.js
*
* This routing file describes the main front end's routing.
*
* Serves as the root page as well as parsing the preset url's generated by the
* application.
*/
var express = require('express')
var router = express.Router()
var config = require('config')
......
/*
* Schedules by Student Run Computing and Technology
*
* tests/standard_test.js
*
* This file describes the linting test to make sure that the project stays
* nice looking.
*/
/* global it describe */
describe('standardjs linting', function () {
this.timeout(20000)
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment