[FIX] jsdoc v3 fixes: @constructs needs an explicit name, @lends is mandatory to not make free-floating methods (interpreted as globals)

bzr revid: xmo@openerp.com-20110912103503-0gpou4t50i2stycp

3 files changed, 56 insertions, 28 deletions

diff --git a/addons/web/static/src/js/boot.js b/addons/web/static/src/js/boot.js
index 2c00eb3d5a5..b9d5180b5c4 100644
--- a/addons/web/static/src/js/boot.js
+++ b/addons/web/static/src/js/boot.js
@@ -5,7 +5,6 @@
 /**
  * @name openerp
  * @namespace openerp
- * @namespace window.openerp
  */
 (function() {
     if (this.openerp)
@@ -48,6 +47,9 @@
  * OpenERP Web web module split
  *---------------------------------------------------------*/
 
+/**
+ * @namespace
+ */
 openerp.web = function(instance) {
     openerp.web.core(instance);
     if (openerp.web.dates) {
diff --git a/addons/web/static/src/js/core.js b/addons/web/static/src/js/core.js
index b5db38d338b..ce69be7f245 100644
--- a/addons/web/static/src/js/core.js
+++ b/addons/web/static/src/js/core.js
@@ -13,11 +13,17 @@ openerp.web.qweb.debug = (window.location.search.indexOf('?debug') !== -1);
         fnTest = /xyz/.test(function(){xyz;}) ? /\b_super\b/ : /.*/;
     // The web Class implementation (does nothing)
     /**
+     * Extended version of John Resig's Class pattern
+     *
      * @class
      */
     openerp.web.Class = function(){};
 
-    // Create a new Class that inherits from this class
+    /**
+     * Subclass an existing class
+     *
+     * @param {Object} prop class-level properties (class attributes and instance methods) to set on the new class
+     */
     openerp.web.Class.extend = function(prop) {
         var _super = this.prototype;
 
@@ -158,7 +164,7 @@ openerp.web.callback = function(obj, method) {
  * that does nothing and always return undefined).
  *
  * @param {Class} claz
- * @param {dict} add Additional functions to override.
+ * @param {Object} add Additional functions to override.
  * @return {Class}
  */
 openerp.web.generate_null_object_class = function(claz, add) {
@@ -189,7 +195,7 @@ openerp.web.KeyNotFound = openerp.web.NotFound.extend( /** @lends openerp.web.Ke
     /**
      * Thrown when a key could not be found in a mapping
      *
-     * @constructs
+     * @constructs openerp.web.KeyNotFound
      * @extends openerp.web.NotFound
      * @param {String} key the key which could not be found
      */
@@ -205,7 +211,7 @@ openerp.web.ObjectNotFound = openerp.web.NotFound.extend( /** @lends openerp.web
      * Thrown when an object path does not designate a valid class or object
      * in the openerp hierarchy.
      *
-     * @constructs
+     * @constructs openerp.web.ObjectNotFound
      * @extends openerp.web.NotFound
      * @param {String} path the invalid object path
      */
@@ -229,7 +235,7 @@ openerp.web.Registry = openerp.web.Class.extend( /** @lends openerp.web.Registry
      * object pointed to (e.g. ``"openerp.web.Session"`` for an OpenERP
      * session object).
      *
-     * @constructs
+     * @constructs openerp.web.Registry
      * @param {Object} mapping a mapping of keys to object-paths
      */
     init: function (mapping) {
@@ -310,7 +316,11 @@ openerp.web.Registry = openerp.web.Class.extend( /** @lends openerp.web.Registry
     }
 });
 
-openerp.web.CallbackEnabled = openerp.web.Class.extend({
+openerp.web.CallbackEnabled = openerp.web.Class.extend(/** @lends openerp.web.CallbackEnabled# */{
+    /**
+     * @constructs openerp.web.CallbackEnabled
+     * @extends openerp.web.Class
+     */
     init: function() {
         // Transform on_* method into openerp.web.callbacks
         for (var name in this) {
@@ -327,9 +337,11 @@ openerp.web.CallbackEnabled = openerp.web.Class.extend({
 
 openerp.web.Session = openerp.web.CallbackEnabled.extend( /** @lends openerp.web.Session# */{
     /**
-     * @constructs
-     * @param server
-     * @param port
+     * @constructs openerp.web.Session
+     * @extends openerp.web.CallbackEnabled
+     *
+     * @param {String} [server] JSON-RPC endpoint hostname
+     * @param {String} [port] JSON-RPC endpoint port
      */
     init: function(server, port) {
         this._super();
@@ -710,13 +722,18 @@ openerp.web.Session = openerp.web.CallbackEnabled.extend( /** @lends openerp.web
     }
 });
 
-/**
- * Utility class that any class is allowed to extend to easy common manipulations.
- *
- * It provides rpc calls, callback on all methods preceded by "on_" or "do_" and a
- * logging facility.
- */
-openerp.web.SessionAware = openerp.web.CallbackEnabled.extend({
+openerp.web.SessionAware = openerp.web.CallbackEnabled.extend(/** @lends openerp.web.SessionAware# */{
+    /**
+     * Utility class that any class is allowed to extend to easy common manipulations.
+     *
+     * It provides rpc calls, callback on all methods preceded by "on_" or "do_" and a
+     * logging facility.
+     *
+     * @constructs openerp.web.SessionAware
+     * @extends openerp.web.CallbackEnabled
+     *
+     * @param {openerp.web.Session} session
+     */
     init: function(session) {
         this._super();
         this.session = session;
@@ -768,7 +785,7 @@ openerp.web.SessionAware = openerp.web.CallbackEnabled.extend({
     }
 });
 
-openerp.web.Widget = openerp.web.SessionAware.extend({
+openerp.web.Widget = openerp.web.SessionAware.extend(/** @lends openerp.web.Widget# */{
     /**
      * The name of the QWeb template that will be used for rendering. Must be
      * redefined in subclasses or the default render() method can not be used.
@@ -786,7 +803,9 @@ openerp.web.Widget = openerp.web.SessionAware.extend({
     /**
      * Construct the widget and set its parent if a parent is given.
      *
-     * @constructs
+     * @constructs openerp.web.Widget
+     * @extends openerp.web.SessionAware
+     *
      * @param {openerp.web.Widget} parent Binds the current instance to the given Widget instance.
      * When that widget is destroyed by calling stop(), the current instance will be
      * destroyed too. Can be null.
@@ -945,17 +964,23 @@ openerp.web.Widget = openerp.web.SessionAware.extend({
 });
 
 /**
+ * @class
+ * @extends openerp.web.Widget
  * @deprecated
  * For retro compatibility only, the only difference with is that render() uses
- * directly `this` instead of context with a "widget" key.
+ * directly ``this`` instead of context with a ``widget`` key.
  */
-openerp.web.OldWidget = openerp.web.Widget.extend({
+openerp.web.OldWidget = openerp.web.Widget.extend(/** @lends openerp.web.OldWidget# */{
     render: function (additional) {
         return openerp.web.qweb.render(this.template, _.extend(_.extend({}, this), additional || {}));
     }
 });
 
-openerp.web.TranslationDataBase = openerp.web.Class.extend({
+openerp.web.TranslationDataBase = openerp.web.Class.extend(/** @lends openerp.web.TranslationDataBase# */{
+    /**
+     * @constructs openerp.web.TranslationDataBase
+     * @extends openerp.web.Class
+     */
     init: function() {
         this.db = {};
         this.parameters = {"direction": 'ltr',
diff --git a/addons/web/static/src/js/data.js b/addons/web/static/src/js/data.js
index 678e4ba7be8..0be8265e53c 100644
--- a/addons/web/static/src/js/data.js
+++ b/addons/web/static/src/js/data.js
@@ -29,7 +29,7 @@ openerp.web.DataGroup =  openerp.web.Widget.extend( /** @lends openerp.web.DataG
      * :js:func:`~openerp.web.DataGroup.list`, which is used to read the
      * content of the current grouping level.
      *
-     * @constructs
+     * @constructs openerp.web.DataGroup
      * @extends openerp.web.Widget
      *
      * @param {openerp.web.Session} session Current OpenERP session
@@ -60,7 +60,7 @@ openerp.web.DataGroup =  openerp.web.Widget.extend( /** @lends openerp.web.DataG
 openerp.web.ContainerDataGroup = openerp.web.DataGroup.extend( /** @lends openerp.web.ContainerDataGroup# */ {
     /**
      *
-     * @constructs
+     * @constructs openerp.web.ContainerDataGroup
      * @extends openerp.web.DataGroup
      *
      * @param session
@@ -197,7 +197,7 @@ openerp.web.ContainerDataGroup = openerp.web.DataGroup.extend( /** @lends opener
 openerp.web.GrouplessDataGroup = openerp.web.DataGroup.extend( /** @lends openerp.web.GrouplessDataGroup# */ {
     /**
      *
-     * @constructs
+     * @constructs openerp.web.GrouplessDataGroup
      * @extends openerp.web.DataGroup
      *
      * @param session
@@ -220,7 +220,7 @@ openerp.web.StaticDataGroup = openerp.web.GrouplessDataGroup.extend( /** @lends
      * A specialization of groupless data groups, relying on a single static
      * dataset as its records provider.
      *
-     * @constructs
+     * @constructs openerp.web.StaticDataGroup
      * @extends openerp.web.GrouplessDataGroup
      * @param {openep.web.DataSetStatic} dataset a static dataset backing the groups
      */
@@ -237,7 +237,7 @@ openerp.web.DataSet =  openerp.web.Widget.extend( /** @lends openerp.web.DataSet
      * DateaManagement interface between views and the collection of selected
      * OpenERP records (represents the view's state?)
      *
-     * @constructs
+     * @constructs openerp.web.DataSet
      * @extends openerp.web.Widget
      *
      * @param {String} model the OpenERP model this dataset will manage
@@ -507,7 +507,8 @@ openerp.web.DataSetStatic =  openerp.web.DataSet.extend({
 });
 openerp.web.DataSetSearch =  openerp.web.DataSet.extend({
     /**
-     * @constructs
+     * @constructs openerp.web.DataSetSearch
+     * @extends openerp.web.DataSet
      *
      * @param {Object} parent
      * @param {String} model