docs(all generators): document methods and properties

generators/app/templates/demo/models/example.coffee

@@ -30,11 +30,29 @@
 
     class ExampleModel extends Backbone.Model
 
+        ###*
+        #   Defaults to initialize missing attributes with when instantiating a new `ExampleModel`.
+        #
+        #   @property       defaults
+        #
+        #   @type           Object
+        #   @protected
+        #   @static
+        #   @final
+        ###
+
         defaults:
             propertyOne:    'this should be a string'
             propertyTwo:    true
 
 
+        ###*
+        #   @method         exampleAsyncFunction
+        #
+        #   @param          {Function}      callback    A callback function to call after one second.
+        #
+        ###
+
         exampleAsyncFunction: ( callback ) ->
 
             setTimeout( () ->

generators/app/templates/demo/views/buildscript.coffee

@@ -33,19 +33,49 @@
 
     class BuildscriptView extends Backbone.View
 
-        # We need to expose our name to the router
+        ###*
+        #   Expose this view's name to the router.
         #
-        viewName:   'buildscript'
-        className:  'buildscript-view'
+        #   @property       viewName
+        #
+        #   @default        'buildscript'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        viewName:           'buildscript'
+
+
+        ###*
+        #   CSS class(es) to set on this view's root DOM element.
+        #
+        #   @property       className
+        #
+        #   @default        'buildscript-view'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        className:          'buildscript-view'
+
 
+        ###*
+        #   @method         render
+        #
+        #   @chainable
+        #
+        ###
 
         render: () ->
 
+            ##  Expand the handlebars template into this view's container element.
+            ##
             @$el.html( template() )
 
-            # By convention always return this so people can chain functions
-            # for example grab the .el after rendering ;-)
-            #
+            ##  This method is chainable.
+            ##
             return @
 
 )

generators/app/templates/demo/views/documentation.coffee

@@ -31,25 +31,49 @@
 
     class DocumentationView extends Backbone.View
 
-        # We need to expose our name to the router
+        ###*
+        #   Expose this view's name to the router.
+        #
+        #   @property       viewName
         #
-        viewName:   'documentation'
-        className:  'documentation-view'
+        #   @default        'documentation'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        viewName:           'documentation'
 
 
         ###*
-        # Function renders the view
+        #   CSS class(es) to set on this view's root DOM element.
         #
-        # @method     render
-        # @return     viewInstance
+        #   @property       className
+        #
+        #   @default        'documentation-view'
+        #   @type           String
+        #   @static
+        #   @final
         ###
+
+        className:          'documentation-view'
+
+
+        ###*
+        #   @method         render
+        #
+        #   @chainable
+        #
+        ###
+
         render: () ->
 
+            ##  Expand the handlebars template into this view's container element.
+            ##
             @$el.html( template() )
 
-            # By convention always return this so people can chain functions
-            # for example grab the .el after rendering ;-)
-            #
+            ##  This method is chainable.
+            ##
             return @
 
 )

generators/app/templates/demo/views/i18n.coffee

@@ -36,47 +36,85 @@
 
     class I18nView extends Backbone.View
 
-        # We need to expose our name to the router
+        ###*
+        #   Expose this view's name to the router.
+        #
+        #   @property       viewName
+        #
+        #   @default        'i18n'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        viewName:           'i18n'
+
+
+        ###*
+        #   CSS class(es) to set on this view's root DOM element.
+        #
+        #   @property       className
         #
-        viewName:   'i18n'
-        className:  'i18n-view'
+        #   @default        'i18n-view'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        className:          'i18n-view'
+
+
+        ###*
+        #   Setup UI event handler definitions.
+        #
+        #   @property       events
+        #
+        #   @type           Object
+        #   @protected
+        #   @static
+        #   @final
+        ###
 
         events:
             'change select[name="language"]': '_changeLanguage'
 
+
         ###*
-        # Function renders the view
+        #   @method         render
+        #
+        #   @chainable
         #
-        # @method     render
-        # @return     viewInstance
         ###
+
         render: () ->
 
-            # Set the template to el
-            #
+            ##  Expand the handlebars template into this view's container element.
+            ##
             @$el.html( template(
                 date:       new Date()
                 money:      100000
                 number:     1090870987
             ))
 
-            # Set the current locale as selected option
-            #
+            ##  Set the current locale as selected option.
+            ##
             @$el.find( "select[name='language'] option[value='#{ localeManager.getLocaleName() }']" ).attr( 'selected', true )
 
-            # By convention always return this so people can chain functions
-            # for example grab the .el after rendering ;-)
-            #
+            ##  This method is chainable.
+            ##
             return @
 
 
         ###*
-        # Private function called when the lanaguage select changes
+        #   Handles changes to the selected language.
+        #
+        #   @method         _changeLanguage
+        #   @protected
         #
-        # @method     render
-        # @private
         ###
+
         _changeLanguage: () ->
+
             $select = @$el.find( 'select[name="language"]' )
 
             localeManager.setLocale( $select.val() ).then(

generators/app/templates/demo/views/index.coffee

@@ -33,24 +33,49 @@
 
     class IndexView extends Backbone.View
 
-        # We need to expose our name to the router
+        ###*
+        #   Expose this view's name to the router.
+        #
+        #   @property       viewName
+        #
+        #   @default        'index'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        viewName:           'index'
+
+
+        ###*
+        #   CSS class(es) to set on this view's root DOM element.
+        #
+        #   @property       className
         #
-        viewName:   'index'
-        className:  'index-view'
+        #   @default        'index-view'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        className:          'index-view'
+
 
         ###*
-        # Function renders the view
+        #   @method         render
+        #
+        #   @chainable
         #
-        # @method     render
-        # @return     viewInstance
         ###
+
         render: () ->
 
+            ##  Expand the handlebars template into this view's container element.
+            ##
             @$el.html( template() )
 
-            # By convention always return this so people can chain functions
-            # for example grab the .el after rendering ;-)
-            #
+            ##  This method is chainable.
+            ##
             return @
 
 )

generators/app/templates/demo/views/navigation.coffee

@@ -33,38 +33,53 @@
 
     class NavigationView extends Backbone.View
 
-        # We need to expose our name to the router
+        ###*
+        #   CSS class(es) to set on this view's root DOM element.
+        #
+        #   @property       className
         #
-        viewName:   'navigation'
-        className:  'navigation-view'
+        #   @default        'navigation-view'
+        #   @type           String
+        #   @static
+        #   @final
+        ###
+
+        className:          'navigation-view'
+
 
         ###*
-        #   Function renders the view
+        #   @method         render
+        #
+        #   @chainable
         #
-        #   @method     render
-        #   @return     viewInstance
         ###
+
         render: () ->
 
+            ##  Expand the handlebars template into this view's container element.
+            ##
             @$el.html( template() )
 
             # Set reference to the navbar
             #
             @$navBar = @$el.find( '.navbar-nav' )
 
-            # By convention always return this so people can chain functions
-            # for example grab the .el after rendering ;-)
-            #
+            ##  This method is chainable.
+            ##
             return @
 
 
         ###*
-        # Function to set the activeMenuItem based on the url passed
+        #   Set the activeMenuItem based on the url passed.
+        #
+        #   @method         setActiveMenuItem
+        #
+        #   @param          {String}    url     Url excluding the hash belonging to the menuitem
         #
-        # @method setActiveMenuItem
-        # @param url {string} Url excluding the hash belonging to the menuitem
         ###
+
         setActiveMenuItem: ( url ) ->
+
             @$navBar.find( '.active' ).removeClass( 'active' )
             @$navBar.find( "a[href='##{url}']" ).closest( 'li' ).addClass( 'active' )