Table of Contents
@lends tag allows you to document all the members of an object literal as if they were members
of a symbol with the given name. You might want to do this if you are passing an object literal into
a function that creates a named class from its members.
In this example, we want to use a helper function to make a class named
Person, along with
instance methods named
say. This is similar to how some popular frameworks
handle class creation.
Without any comments, JSDoc won't recognize that this code creates a
Person class with two
methods. To document the methods, we must use a
@lends tag in a doc comment immediately before the
object literal. The
@lends tag tells JSDoc that all the member names of that object literal are
being "loaned" to a variable named
Person. We must also add comments to each of the methods.
The following example gets us closer to what we want:
Now the functions named
say will be documented, but they appear as static methods
Person class. That is possibly what you meant, but in this case we want
say to belong to the instances of the
Person class. So we change things slightly by lending the
methods to the class's prototype:
One final step: Our class framework uses the loaned
initialize function to construct
instances, but a
Person instance does not have its own
initialize method. The solution is to add
@constructs tag to the loaned function. Remember to remove the
@class tag as well, or else
two classes will be documented.