Databases
StackOverflow2013
Postsdbo
POBest way to document anonymous objects and functions with jsdoc
 

Note that there are some explanatory texts on larger screens.

plurals
  1. POBest way to document anonymous objects and functions with jsdoc
    primarykey
    data
    text
    <p>Edit: This is technically a 2 part question. I've chosen the best answer that covers the question in general and linked to the answer that handles the specific question.</p> <p>What is the best way to document anonymous objects and functions with jsdoc?</p> <pre><code>/** * @class {Page} Page Class specification */ var Page = function() { /** * Get a page from the server * @param {PageRequest} pageRequest Info on the page you want to request * @param {function} callback Function executed when page is retrieved */ this.getPage = function(pageRequest, callback) { }; }; </code></pre> <p>Neither the <code>PageRequest</code> object or the <code>callback</code> exist in code. They will be provided to <code>getPage()</code> at runtime. But I would like to be able to define what the object and function are.</p> <p>I can get away with creating the <code>PageRequest</code> object to document that:</p> <pre><code>/** * @namespace {PageRequest} Object specification * @property {String} pageId ID of the page you want. * @property {String} pageName Name of the page you want. */ var PageRequest = { pageId : null, pageName : null }; </code></pre> <p>And that's fine (though I'm open to better ways to do this).</p> <p>What is the best way to document the <code>callback</code> function? I want to make it know in the document that, for example, the callback function is in the form of:</p> <pre><code>callback: function({PageResponse} pageResponse, {PageRequestStatus} pageRequestStatus) </code></pre> <p>Any ideas how to do this? </p>
    singulars
    1. PO
      singulars
      1. PTAnswer
    1. This table or related slice is empty.
    1. PTQuestion
    1. USalex
    1. USJosh Johnson
    plurals
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. This table or related slice is empty.
    1. PO
      singulars
      1. PTAnswer
    2. PO
      singulars
      1. PTAnswer
    3. PO
      singulars
      1. PTAnswer
    1. VO
      singulars
      1. POBest way to document anonymous objects and functions with jsdoc
      1. This table or related slice is empty.
      1. VTUpMod
    2. VO
      singulars
      1. POBest way to document anonymous objects and functions with jsdoc
      1. USGeorge Marian
      1. VTFavorite
    3. VO
      singulars
      1. POBest way to document anonymous objects and functions with jsdoc
      1. This table or related slice is empty.
      1. VTUpMod
    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.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload