StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
primarykey
Id
17193781
data
AcceptedAnswerId
0
AnswerCount
0
ClosedDate
CommentCount
0
CommunityOwnedDate
CreationDate
2013-06-19T14:21:55.633
FavoriteCount
0
LastActivityDate
2013-06-19T15:14:46.287
LastEditDate
2013-06-19T15:14:46.287
LastEditorUserId
215148
OwnerUserId
215148
ParentId
15842750
PostTypeId
2
Score
1
ViewCount
0
LastEditorDisplayName
text
Body
I just struggled with this for several hours. I tried: <ul> <li><code>@member</code></li> <li><code>@augments</code></li> <li><code>@method</code></li> <li><code>@this</code></li> </ul> From the examples and tutorials I found, member functions and variables should appear in the output simply by having <code>/** description/*</code> comments above them, but I found that was not the case. Like you, I'm using standard JavaScript constructors, where <code>this</code> should be able to be inferred automatically due to the <code>@constructor</code> being in place. Maybe there's some wrinkle I'm not seeing. In the end, I found two tags that worked for me, <a href="http://usejsdoc.org/tags-name.html" rel="nofollow noreferrer"><code>@name</code></a> and<a href="http://usejsdoc.org/tags-memberof.html" rel="nofollow noreferrer"><code>@memberof</code></a>. They both allow you to specify the object that the property is a member of. Using <code>@name</code> in this way is undocumented (at least, I didn't see it anywhere), but very straightforward. You'll also need to use <code>@function</code>. Here's an example with the <code>@name</code> tag: <pre><code>/** help function * @name Sample.try * @function * @param {String} Name */ this.try=function(name){ console.log('try me'+name); }; </code></pre> <img src="https://i.stack.imgur.com/UcaHJ.png" alt="enter image description here"> And here's an example with the <code>@memberof</code> tag: <pre><code>/** help function * @memberof Sample * @function * @param {String} Name */ this.try=function(name){ console.log('try me'+name); }; </code></pre> <img src="https://i.stack.imgur.com/KJNM2.png" alt="enter image description here"> As you can see the output is almost the same. The only difference that I see is that <code>@memberof</code> includes <code>this.</code> in the method name. For that reason I've settled on using <code>@name</code>. The remaining issue is that the functions are per-instance, not <code><static></code>. Hope this helps!
Tags
Title
singulars
PostAcceptedAnswerId
1. This table or related slice is empty.
PostParentId
1. POHow to Document following function in JSDoc JS-Toolkit
 singulars
 PostTypePostTypeId
 PTQuestion
PostTypePostTypeId
1. PTAnswer
UserLastEditorUserId
1. USmwcz
UserOwnerUserId
1. USmwcz
plurals
PostLinksPostIdRelatedPostId
1. This table or related slice is empty.
PostLinksRelatedPostIdPostId
1. This table or related slice is empty.
PostsAcceptedAnswerId
1. This table or related slice is empty.
PostsParentIdCreationDate
1. This table or related slice is empty.
VotesPostIdCreationDate
1. VO
 singulars
 PostPostId
 PO
 UserUserId
 This table or related slice is empty.
 VoteTypeVoteTypeId
 VTUpMod
CommentsPostId
1. This table or related slice is empty.

Querying!

Guidance

A row detail

Detail views are divided into sections. All the information in the data section comes from columns in the selected row. The other sections display data from other, related rows.

Related data can be related in a to-one or a to-many fashion. Captions of data related in a to-many fashion link to a list view showing a filtered view of the table.

Try moving around until you find a non-empty to-many entry and click on the label to get to one. You can move back to the root by clicking on the database name in the header.