From ccf6a1a1be5e23cae9b580f9d6f333acf3a77003 Mon Sep 17 00:00:00 2001
From: devlinjd <james@indevious.com>
Date: Wed, 23 Sep 2015 00:26:24 -0400
Subject: [PATCH] Reorganize sources.

---
 src/gen/base-generator.js     | 7 ++++++-
 src/gen/template-generator.js | 5 +++++
 src/gen/text-generator.js     | 4 ++++
 src/scrappy.js                | 2 +-
 src/sheet.js                  | 2 +-
 src/{gen => utils}/class.js   | 0
 src/{ => utils}/extend.js     | 0
 7 files changed, 17 insertions(+), 3 deletions(-)
 rename src/{gen => utils}/class.js (100%)
 rename src/{ => utils}/extend.js (100%)

diff --git a/src/gen/base-generator.js b/src/gen/base-generator.js
index dcb319b..e53d908 100644
--- a/src/gen/base-generator.js
+++ b/src/gen/base-generator.js
@@ -4,7 +4,12 @@ Base resume generator for FluentCV.
 */
 
 (function() {
-  var Class = require( './class' );
+  var Class = require( '../utils/class' );
+
+  /**
+  The BaseGenerator class is the root of the generator hierarchy. Functionality
+  common to ALL generators lives here.
+  */
   var BaseGenerator = module.exports = Class.extend({
     init: function( outputFormat ) {
       this.format = outputFormat;
diff --git a/src/gen/template-generator.js b/src/gen/template-generator.js
index b093413..a1e08a0 100644
--- a/src/gen/template-generator.js
+++ b/src/gen/template-generator.js
@@ -34,6 +34,11 @@ Template-based resume generator base for FluentCV.
     prettyIndent: 2
   };
 
+  /**
+  TemplateGenerator performs resume generation via Underscore-style template
+  expansion and is appropriate for text-based formats like HTML, plain text,
+  and XML versions of Microsoft Word, Excel, and OpenOffice.
+  */
   var TemplateGenerator = BaseGenerator.extend({
 
     /** outputFormat: html, txt, pdf, doc
diff --git a/src/gen/text-generator.js b/src/gen/text-generator.js
index 46b1420..5aa077b 100644
--- a/src/gen/text-generator.js
+++ b/src/gen/text-generator.js
@@ -4,6 +4,10 @@ Plain text resume generator for FluentCV.
 */
 
 var TemplateGenerator = require('./template-generator');
+
+/**
+The TextGenerator generates a plain-text resume via the TemplateGenerator.
+*/
 var TextGenerator = TemplateGenerator.extend({
 
   init: function(){
diff --git a/src/scrappy.js b/src/scrappy.js
index b34e06e..a67eee6 100644
--- a/src/scrappy.js
+++ b/src/scrappy.js
@@ -11,7 +11,7 @@ module.exports = function () {
     , FS   = require( 'fs-extra' )
     , XML  = require( 'xml-escape' )
     , path = require( 'path' )
-    , extend = require( './extend' )
+    , extend = require( './utils/extend' )
     , _ = require('underscore')
     , Sheet = require('./sheet')
     , HtmlGenerator = require('./gen/html-generator')
diff --git a/src/sheet.js b/src/sheet.js
index b48498d..a22a867 100644
--- a/src/sheet.js
+++ b/src/sheet.js
@@ -6,7 +6,7 @@ Abstract character/resume sheet representation.
 (function() {
 
   var FS = require('fs')
-    , extend = require('./extend')
+    , extend = require('./utils/extend')
     , validator = require('is-my-json-valid')
     , _ = require('underscore')
     , moment = require('moment');
diff --git a/src/gen/class.js b/src/utils/class.js
similarity index 100%
rename from src/gen/class.js
rename to src/utils/class.js
diff --git a/src/extend.js b/src/utils/extend.js
similarity index 100%
rename from src/extend.js
rename to src/utils/extend.js