Jetpack/SDK/Writing Documentation: Difference between revisions

  <api name="postMessage">

  @function

  Use this function to send a message

  to any [content scripts](/link/to/doc.html).

  </api>

  <api name="open">

  @event

  This event is generated when the

  corresponding `tab` object is opened.

  </api>

  <api name="panel">

  @class

  ...

     ...

     </api>

  </api>

  <api name="alert">

   @method

   Displays an alert message.

   

   @param anotherparam {bool}

   

  </api>

  <api name="alert">

   @method

   Displays an alert message.

   @param [alerttext] {string}

   The string to display.

If the parameter has a default value, then the name is followed by "=" and then the default value:

  <api name="alert">

   @method

   Displays an alert message.

   

   @param [anotherparam=false] {bool}

Parameters can contain properties of their own. In this case the properties are listed after the parameter description, using a line which:

   @prop [onOpen] {function}

   A callback function that is called when the window has opened.

==== Return values ====

  <api name="label">

  @property {string}

   The widget's label.  Read-only.

  </api>

  <api name="complete">

  @event