boolean doSimpleList(
string
$word)
Return a simple list, if found
This helper function extracts a simple list beginning with any of 'o','-'.'#','+','0','1','0.','1.' and starts parsing it.
Tags:
return: true if a list is found, false otherwise
Parameters:
string
$word
line that may contain a simple list
void parse(
array
&$parse_data, [boolean
$sdesc = false], [string
$ind_type = 'parserDesc'])
Parse a long or short description for tags
Tags:
staticvar: integer $endrecur: used for recursion limiting if a handler for an event is not found
Overrides
Parser::parse() (Parse a new file)
Parameters:
boolean
$sdesc
true if the description is a short description. (only 1 paragraph allowed in short desc)
string
$ind_type
name of the class to instantiate for each paragraph. parserDesc for desc/sdesc, parserStringWithInlineTags for tag data
void setupStates(
boolean
$sdesc)
setup the parser tokens, and the pushEvent/popEvent arrays
Tags:
global: boolean 0: used to determine whether to slow things down or not by
eliminating whitespace from comments
Overrides
Parser::setupStates() (setup the parser tokens, and the pushEvent/popEvent arrays)
Parameters:
boolean
$sdesc
determines whether to allow paragraph parsing