Check SwMethodDoc

sw-method-doc - Method is missing documentation

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 with PARAM1.
  ## Then it returns _true.
  return _true
_endmethod

Note that parameters must occur in uppercase in the method documentation.

Options

Option	Default value	Description
sw-method-doc.allow-blank-method-doc	false	Allow blank method doc

Note

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