Check TypeDoc

type-doc - Method/procedure/slotted exemplar is missing documentation

For more information on how to write good TypeDoc, view the Wiki.

Non-compliant Code Example

_method object.do_something(param1)
  ## This method does something.
  ## Then it returns _true.
  return _true
_endmethod

Compliant Code Example

_method object.do_something(param1)
  ## This method does something.
  ## @param {sw:char16_vector} param1 This parameter is used to do domething.
  ## @return {sw:true|sw:false} True if successful, false if not.
  _return _true
_endmethod

Non-compliant Code Example

def_slotted_exemplar(
  :test_exemplar,
  {
    {:slot1, _unset}
  })

Compliant Code Example

## @slot {sw:rope} slot1 Slot 1.
def_slotted_exemplar(
  :test_exemplar,
  {
    {:slot1, _unset}
  })

Note

This page is generated. Any changes made to this page through the wiki will be lost in the future.