Apply yuidoc's internal linting to our docs.

app/views/utils.js

 /*
 This file is part of the Juju GUI, which lets users view and manage Juju
 environments within a graphical interface (https://launchpad.net/juju-gui).
 Copyright (C) 2012-2013 Canonical Ltd.
 
 This program is free software: you can redistribute it and/or modify it under
 the terms of the GNU Affero General Public License version 3, as published by
 the Free Software Foundation.
 
 This program is distributed in the hope that it will be useful, but WITHOUT
@@ skipping 243 matching lines @@
     var l = timestrings,
         prefix = l.prefixAgo,
         suffix = l.suffixAgo,
         distanceMillis = Y.Lang.now() - t,
         seconds = Math.abs(distanceMillis) / 1000,
         minutes = seconds / 60,
         hours = minutes / 60,
         days = hours / 24,
         years = days / 365;
 
-    /**
+    /*
       Given a number and a way to convert the number to a string that is a
       template or a function producing a template string, return the template
       substituted with the number.
 
       Internal helper function to humanizeTimestamp, intentionally not
       formatted to be included in exported docs.
     */
     function substitute(stringOrFunction, number) {
       var string = Y.Lang.isFunction(stringOrFunction) ?
           stringOrFunction(number, distanceMillis) : stringOrFunction,
@@ skipping 928 matching lines @@
     }
     return ret;
   });
 
   Y.Handlebars.registerHelper('markdown', function(text) {
     if (!text || text === undefined) {return '';}
     return new Y.Handlebars.SafeString(
         Y.Markdown.toHTML(text));
   });
 
-  /**
+  /*
    * Generate a landscape badge using a partial internally.
    */
   Y.Handlebars.registerHelper('landscapeBadge', function(
       landscape, model, intent, hint) {
         if (!landscape) {
           return '';
         }
         var output = '';
         var badge = landscape.getLandscapeBadge(model, intent, hint);
 
@@ skipping 23 matching lines @@
         res = res + options.fn({
           key: key,
           value: object[key]
         });
       });
     }
     return res;
   });
 
 
-  /**
+  /*
     If built around checking if x == y.
     Supports an inverse so that we can use an else clause.

[jeff.pihach, 2013/06/05 19:53:22]

I wonder if there is a proper way to document these using @module

[benji, 2013/06/05 20:01:04]

I was wondering the same thing but I didn't find anything quickly.

-
    */
   Y.Handlebars.registerHelper('if_eq', function(x, y, options) {
     if (x === y) {
       return options.fn(this);
     } else {
       return options.inverse(this);
     }
   });
 
-  /**
+  /*
     * pluralize
     *
     * pluralize is a handlebar helper that handles pluralization of strings.
     * The requirement for pluralization is based on the passed in object,
     * which can be number, array, or object. If a number, it is directly
     * checked to see if pluralization is needed. Arrays and objects are
     * checked for length or size attributes, which are then used.
     *
     * By default, if pluralization is needed, an 's' is appended to the
     * string. This handles the regular case (e.g. cat => cats). Irregular
@@ skipping 16 matching lines @@
           if (typeof(plural_word) === 'string') {
             return plural_word;
           } else {
             return word + 's';
           }
         } else {
           return word;
         }
       });
 
-  /**
+  /*
    * Truncate helper to keep text sizes to a specified limit.
    *
    * {{truncate field 100}}
    *
    */
   Y.Handlebars.registerHelper('truncate', function(string, length) {
     if (string && string.length > length) {
       return Y.Lang.trimRight(string.substring(0, length)) + '...';
     }
     else {
       return string;
     }
   });
 
-  /**
+  /*
    * Extension for views to provide an apiFailure method.
    *
    * @class apiFailure
    */
   utils.apiFailingView = function() {
     this._initAPIFailingView();
   };
   utils.apiFailingView.prototype = {
     /**
      * Constructor
@@ skipping 40 matching lines @@
     'base-build',
     'handlebars',
     'node',
     'view',
     'panel',
     'json-stringify',
     'gallery-markdown',
     'datatype-date-format'
   ]
 });