feat(app generator): introduce settings as a static @class to yui…

…doc code documentation
marviq · Aug 26, 2016 · e9a0c84 · e9a0c84
1 parent bcb25c6
commit e9a0c84
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/generators/app/templates/src/app.coffee b/generators/app/templates/src/app.coffee
@@ -159,6 +159,15 @@ do () ->
 ##  [madlib]
 ##
 
+###*
+#   The app's globally sharable configuration settings.
+#
+#   These are exposed through the `madlib-settings` singleton object. Simply `require(...)` it wherever you have a need for them.
+#
+#   @class      Settings
+#   @static
+###
+
 ##  https://github.com/Qwerios/madlib-settings#readme
 ##
 settings        = require( 'madlib-settings' )