From fc0d3743ecec7a81d888e63d1da5a240b3180f68 Mon Sep 17 00:00:00 2001
From: Mark Stenglein <mark@stengle.in>
Date: Sat, 24 Dec 2016 03:15:34 -0500
Subject: [PATCH] update headers on files to make them more descriptive

---
 app.js                | 12 +++++++-----
 routes/api/v1.js      | 15 ++++++++++-----
 routes/docs.js        | 18 ++++++++++++------
 routes/index.js       | 17 +++++++++++------
 test/standard_test.js |  9 +++++++++
 5 files changed, 49 insertions(+), 22 deletions(-)

diff --git a/app.js b/app.js
index a4dc7ff..af78b1d 100644
--- a/app.js
+++ b/app.js
@@ -1,8 +1,10 @@
-//              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)
diff --git a/routes/api/v1.js b/routes/api/v1.js
index 6903764..39e0c5b 100644
--- a/routes/api/v1.js
+++ b/routes/api/v1.js
@@ -1,8 +1,13 @@
-// ////////////////////////////////////////////////////////////////////////////
-//                         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()
diff --git a/routes/docs.js b/routes/docs.js
index 7bdb7c0..2579594 100644
--- a/routes/docs.js
+++ b/routes/docs.js
@@ -1,9 +1,15 @@
-// //////////////////////////////////////////////////////////////////////////////
-//                 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')
diff --git a/routes/index.js b/routes/index.js
index 31924a5..bbd8cd0 100644
--- a/routes/index.js
+++ b/routes/index.js
@@ -1,9 +1,14 @@
-// //////////////////////////////////////////////////////////////////////////////
-//                 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')
diff --git a/test/standard_test.js b/test/standard_test.js
index fb5a660..f1c40a9 100644
--- a/test/standard_test.js
+++ b/test/standard_test.js
@@ -1,3 +1,12 @@
+/*
+ * 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)
-- 
GitLab