Configuration
Configuration keys for the Solar_Markdown_Apidoc_MethodSynopsis class.
markdown
(Solar_Markdown) The "parent" Markdown object.
Default:
null
synopsis
(string) The "main" format string.
Default:
'<methodsynopsis> %access %return %method %params %throws </methodsynopsis>'
access
(string) The format string for access type.
Default:
'<modifier>%access</modifier>'
return
(string) The format string for return type.
Default:
'<type>%return</type>'
method
(string) The format string for the method name.
Default:
'<methodname>%method</methodname>'
param
(string) The format string for required params.
Default:
' <methodparam><type>%type</type> <parameter>%name</parameter></methodparam>'
param_default
(string) The format string for params with a default value.
Default:
' <methodparam><type>%type</type> <parameter>%name</parameter> <initializer>%default</initializer></methodparam>'
param_void
(string) The format string for a method with no params.
Default:
'<void />'
throws
(string) The format string for throws.
Default:
' <exceptionname>%type</exceptionname>'
list_sep
(string) The list separator for params and throws.
Default:
''