Add yuidoc linter.

undocumented

 app/app.js callback
-app/app.js getModelURL

[gary.poster, 2012/10/29 10:21:09]

uh oh.

This method has a very nice doc string, which you formatted in the previous
branch.  I've never had the opportunity to use this quote more aptly than I do
now: something is rotten in the state of Denmark!

This is not caught by your linter, even given the "complain when supposedly
undocumented things are actually documented" clause, which suggests the linter
has some bugs.  Am I right?

[benji.york, 2012/10/29 11:20:44]

You are right.  The problem was that we're not really parsing the JS.  I
slightly complexified the heuristic to fix it.  If we have to do much more to it
I would recommend switching to using the output of yuidoc (yuidoc/data.json) to
decide if a function is documented or not.

 app/models/charm.js compare
 app/models/charm.js failure
 app/models/charm.js initializer
 app/models/charm.js parse
 app/models/charm.js sync
 app/models/charm.js validator
+app/models/endpoints.js add
+app/models/endpoints.js convert
+app/models/models.js _setDefaultsAndCalculatedValues
 app/models/models.js add
 app/models/models.js comparator
-app/models/models.js get_informative_states_for_service
 app/models/models.js getModelById
 app/models/models.js getModelFromChange
 app/models/models.js getModelListByModelName
 app/models/models.js getNotificationsForModel
+app/models/models.js get_informative_states_for_service
 app/models/models.js get_relations_for_service
 app/models/models.js get_units_for_service
 app/models/models.js has_relation_for_endpoint
 app/models/models.js initializer
 app/models/models.js on_delta
 app/models/models.js process_delta
 app/models/models.js removeOldest
 app/models/models.js reset
-app/models/models.js _setDefaultsAndCalculatedValues
 app/models/models.js setter
 app/models/models.js trim
 app/models/models.js update_service_unit_aggregates
 app/models/models.js valueFn
+app/store/charm.js _normalizeCharms
 app/store/charm.js find
 app/store/charm.js loadByPath
-app/store/charm.js _normalizeCharms
 app/store/charm.js setter
 app/store/charm.js success
+app/store/env.js Environment
+app/store/env.js _dispatch_event
+app/store/env.js _dispatch_rpc_result
+app/store/env.js _send_rpc
 app/store/env.js add_relation
 app/store/env.js add_unit
 app/store/env.js connect
 app/store/env.js deploy
 app/store/env.js destroy_service
 app/store/env.js destructor
-app/store/env.js _dispatch_event
 app/store/env.js dispatch_result
-app/store/env.js _dispatch_rpc_result
 app/store/env.js expose
 app/store/env.js get_charm
 app/store/env.js get_endpoints
 app/store/env.js get_service
 app/store/env.js initializer
 app/store/env.js on_close
 app/store/env.js on_message
 app/store/env.js on_open
 app/store/env.js remove_relation
 app/store/env.js remove_units
 app/store/env.js resolved
-app/store/env.js _send_rpc
 app/store/env.js set_config
 app/store/env.js set_constraints
 app/store/env.js status
 app/store/env.js unexpose
 app/store/notifications.js evict
 app/store/notifications.js generate_notices
 app/store/notifications.js level
 app/store/notifications.js message
 app/store/notifications.js title
+app/views/charm-search.js _moveTooltip
+app/views/charm-search.js _showErrors
+app/views/charm-search.js calculatePanelPosition
+app/views/charm-search.js createInstance
+app/views/charm-search.js deploy
+app/views/charm-search.js getInstance
+app/views/charm-search.js goBack
+app/views/charm-search.js hide
+app/views/charm-search.js hideDescription
+app/views/charm-search.js initializer
+app/views/charm-search.js killInstance
+app/views/charm-search.js mouseenter
+app/views/charm-search.js mouseleave
+app/views/charm-search.js onCharmDeployClicked
+app/views/charm-search.js onFileChange
+app/views/charm-search.js onFileError
+app/views/charm-search.js onFileLoaded
+app/views/charm-search.js onFileRemove
+app/views/charm-search.js render
+app/views/charm-search.js setDefaultSeries
+app/views/charm-search.js setPanel
+app/views/charm-search.js setupOverlay
+app/views/charm-search.js show
+app/views/charm-search.js showConfiguration
+app/views/charm-search.js showDescription
+app/views/charm-search.js showDetails
+app/views/charm-search.js toggle
+app/views/charm-search.js updatePopupPosition
 app/views/charm.js _deployCallback
 app/views/charm.js initializer
 app/views/charm.js on_charm_data
 app/views/charm.js on_charm_deploy
 app/views/charm.js on_results_change
 app/views/charm.js on_search_change
 app/views/charm.js render
-app/views/charm-search.js deploy
-app/views/charm-search.js getInstance
-app/views/charm-search.js goBack
-app/views/charm-search.js hideDescription
-app/views/charm-search.js initializer
-app/views/charm-search.js killInstance
-app/views/charm-search.js mouseenter
-app/views/charm-search.js mouseleave
-app/views/charm-search.js _moveTooltip
-app/views/charm-search.js onCharmDeployClicked
-app/views/charm-search.js onFileChange
-app/views/charm-search.js onFileError
-app/views/charm-search.js onFileLoaded
-app/views/charm-search.js onFileRemove
-app/views/charm-search.js render
-app/views/charm-search.js setDefaultSeries
-app/views/charm-search.js setupOverlay
-app/views/charm-search.js showConfiguration
-app/views/charm-search.js showDescription
-app/views/charm-search.js showDetails
-app/views/charm-search.js _showErrors
+app/views/environment.js _addRelationCallback
+app/views/environment.js _bindEvent
+app/views/environment.js _destroyCallback
+app/views/environment.js _fire_zoom
+app/views/environment.js _removeRelationCallback
 app/views/environment.js addRelation
-app/views/environment.js _addRelationCallback
 app/views/environment.js addRelationDrag
 app/views/environment.js addRelationDragEnd
 app/views/environment.js addRelationDragStart
 app/views/environment.js addRelationEnd
 app/views/environment.js addRelationStart
 app/views/environment.js ambiguousAddRelationCheck
 app/views/environment.js attachSceneEvents
 app/views/environment.js buildScene
 app/views/environment.js cancelRelationBuild
 app/views/environment.js click
-app/views/environment.js _destroyCallback
 app/views/environment.js destroyService
 app/views/environment.js destroyServiceConfirm
 app/views/environment.js detachSceneEvents
 app/views/environment.js drawRelation
 app/views/environment.js drawRelationGroup
 app/views/environment.js drawService
 app/views/environment.js fade
-app/views/environment.js _fire_zoom
 app/views/environment.js hide
 app/views/environment.js hideGraphListPicker
 app/views/environment.js initializer
 app/views/environment.js mouseenter
 app/views/environment.js mouseleave
 app/views/environment.js mouseout
 app/views/environment.js mouseover
 app/views/environment.js postRender
 app/views/environment.js processRelation
 app/views/environment.js processRelations
 app/views/environment.js relationClick
 app/views/environment.js removeRelation
-app/views/environment.js _removeRelationCallback
 app/views/environment.js removeRelationConfirm
 app/views/environment.js render
 app/views/environment.js renderSlider
 app/views/environment.js rescale
 app/views/environment.js serviceClick
 app/views/environment.js serviceDblClick
 app/views/environment.js serviceForBox
 app/views/environment.js setSizesFromViewport
 app/views/environment.js show
 app/views/environment.js showGraphListPicker
 app/views/environment.js show_service
+app/views/environment.js styleToNumber
 app/views/environment.js subordinateRelationsForService
 app/views/environment.js toggleControlPanel
 app/views/environment.js updateCanvas
 app/views/environment.js updateData
+app/views/environment.js updateLinks
 app/views/environment.js updateServiceMenuLocation
 app/views/environment.js zoom_in
 app/views/environment.js zoom_out
 app/views/notifications.js close
 app/views/notifications.js getShowable
 app/views/notifications.js initializer
 app/views/notifications.js notificationSelect
 app/views/notifications.js notifyToggle
 app/views/notifications.js render
 app/views/notifications.js slowRender
 app/views/service.js _addUnitCallback
+app/views/service.js _destroyCallback
+app/views/service.js _exposeServiceCallback
+app/views/service.js _modifyUnits
+app/views/service.js _removeRelationCallback
+app/views/service.js _removeUnitCallback
+app/views/service.js _setConfigCallback
+app/views/service.js _setConstraintsCallback
+app/views/service.js _unexposeServiceCallback
 app/views/service.js confirmDestroy
 app/views/service.js confirmRemoved
-app/views/service.js _destroyCallback
 app/views/service.js destroyService
 app/views/service.js doRemoveRelation
 app/views/service.js exposeService
-app/views/service.js _exposeServiceCallback
 app/views/service.js filterUnits
 app/views/service.js fitToWindow
+app/views/service.js getHeight
 app/views/service.js getServiceTabs
 app/views/service.js initializer
 app/views/service.js modifyUnits
-app/views/service.js _modifyUnits
-app/views/service.js _removeRelationCallback
-app/views/service.js _removeUnitCallback
 app/views/service.js render
 app/views/service.js resetUnits
 app/views/service.js saveConfig
-app/views/service.js _setConfigCallback
-app/views/service.js _setConstraintsCallback
 app/views/service.js showErrors
 app/views/service.js unexposeService
-app/views/service.js _unexposeServiceCallback
 app/views/service.js updateConstraints
+app/views/unit.js _removeUnitCallback
+app/views/unit.js _resolvedRelationCallback
+app/views/unit.js _resolvedUnitCallback
 app/views/unit.js confirmRemoved
 app/views/unit.js confirmResolved
 app/views/unit.js confirmResolvedRelation
 app/views/unit.js doRemoveUnit
 app/views/unit.js doResolvedRelation
 app/views/unit.js doResolvedUnit
 app/views/unit.js initializer
-app/views/unit.js _removeUnitCallback
-app/views/unit.js _resolvedRelationCallback
-app/views/unit.js _resolvedUnitCallback
 app/views/unit.js retry
 app/views/unit.js retryRelation
+app/views/utils.js BoundingBox
+app/views/utils.js Box
+app/views/utils.js BoxPair
+app/views/utils.js _addAlertMessage
 app/views/utils.js action
 app/views/utils.js addSVGClass
 app/views/utils.js bindModelView
 app/views/utils.js console
 app/views/utils.js get
 app/views/utils.js hasSVGClass
 app/views/utils.js humanizeNumber
+app/views/utils.js invokeCallback
+app/views/utils.js isFloat
+app/views/utils.js isInt
 app/views/utils.js native
 app/views/utils.js noop
+app/views/utils.js pair
 app/views/utils.js removeSVGClass
 app/views/utils.js renderable_charm
 app/views/utils.js scale
 app/views/utils.js set
+app/views/utils.js substitute
+app/views/utils.js toString
 app/views/utils.js toggleSVGClass
 app/views/utils.js translate