Updated code documentation #20
Conversation
| @@ -16,18 +19,21 @@ var SELF = wb.datamodel.Entity = function WbDataModelEntity() { | |||
|
|
|||
| /** | |||
| * String to identify this type of Entity. | |||
| * @type {string} | |||
| * @type {null} | |||
There was a problem hiding this comment.
That's odd. In the subclasses this is a string. I think this must be {string|null}.
There was a problem hiding this comment.
I was not sure about that. It is never set via a constructor and stands for itself here but it probably makes more sense to keep it on {string}.
|
I read everything and left a few comments. Looking forward to merge this. Good work. |
| @@ -113,7 +122,8 @@ wb.datamodel.EntityId = util.inherit( | |||
| } ); | |||
|
|
|||
| /** | |||
| * @see dataValues.DataValue.newFromJSON | |||
| * @inheritdoc | |||
| * @static | |||
| */ | |||
| wb.datamodel.EntityId.newFromJSON = function( json ) { | |||
There was a problem hiding this comment.
Missing param/return documentation. (wb.datamodel.EntityId.TYPE below needs documentation as well)
snaterlicious
force-pushed
the
documentation
branch
2 times, most recently
from
1ccd2dc
to
d8a3026
Compare
|
I don't agree with dropping the |
Allows generating a proper documentation using JSDuck. (A custom JSDuck tag class for "licence" tag should be applied upon generation.)
snaterlicious
force-pushed
the
documentation
branch
from
1f380b4
to
271b1e6
Compare
Allows generating a proper documentation using JSDuck.
(A custom JSDuck tag class for "licence" tag should be applied upon generation.)