Jetpack/SDK/Writing Documentation: Difference between revisions

Jump to navigation Jump to search
Line 188: Line 188:
=== <code>event</code> components ===
=== <code>event</code> components ===


If the code emits events you use the <code>event</code> component to document them. The only extra bit of syntax events need is to define the arguments that will be passed into any listener functions, and this is done using a "@argument" tag, followed by the data type of the argument in braces:
If the code emits events you use the <code>event</code> component to document them. The only extra bit of syntax events need is to define the arguments that will be passed into any listener functions, and this is done using a line which:
 
* starts with "@argument"
* is followed by the data type of the argument in braces:


  <api name="complete">
  <api name="complete">
canmove, Confirmed users
737

edits

Navigation menu