Configuration

Configuration keys for the Solar_Markdown_Wiki_MethodSynopsis class.

markdown

  • (Solar_Markdown) The "parent" Markdown object.

  • Default: null

synopsis

  • (string) The "main" format string.

  • Default: '<div class="method-synopsis"> %access %return %method (%params )%throws </div>'

access

  • (string) The format string for access type.

  • Default: '<span class="access">%access</span>'

return

  • (string) The format string for return type.

  • Default: '<span class="return">%return</span>'

method

  • (string) The format string for the method name.

  • Default: '<span class="method">%method</span>'

param

  • (string) The format string for required params.

  • Default: ' <span class="param"><span class="type">%type</span> <span class="name">$%name</span>'

param_default

  • (string) The format string for params with a default value.

  • Default: ' <span class="param-default"><span class="type">%type</span> <span class="name">$%name</span> default <span class="default">%default</span>'

param_void

  • (string) The format string for a method with no params.

  • Default: ' '

throws

  • (string) The format string for throws.

  • Default: ' <span class="throws">throws <span class="type">%type</span></span>'

list_sep

  • (string) The list separator for params and throws.

  • Default: ', '



Local