summaryrefslogtreecommitdiff
path: root/lib/plugins/syntax.php
diff options
context:
space:
mode:
authorAndreas Gohr <andi@splitbrain.org>2014-05-25 12:24:14 +0200
committerAndreas Gohr <andi@splitbrain.org>2014-05-25 12:24:14 +0200
commit7ac0b9fe750a5713353e6edce51493a8a75c4f6f (patch)
treeb82ef6ea65695bfaff1cb37adbbd28bd9b492bb9 /lib/plugins/syntax.php
parent6fc4ea2c9a414260900dbe10478d307dc3e952c0 (diff)
downloadrpg-7ac0b9fe750a5713353e6edce51493a8a75c4f6f.tar.gz
rpg-7ac0b9fe750a5713353e6edce51493a8a75c4f6f.tar.bz2
just some more doc blocks
Diffstat (limited to 'lib/plugins/syntax.php')
-rw-r--r--lib/plugins/syntax.php11
1 files changed, 10 insertions, 1 deletions
diff --git a/lib/plugins/syntax.php b/lib/plugins/syntax.php
index 42a4903ec..4a301f927 100644
--- a/lib/plugins/syntax.php
+++ b/lib/plugins/syntax.php
@@ -20,9 +20,12 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
* Syntax Type
*
* Needs to return one of the mode types defined in $PARSER_MODES in parser.php
+ *
+ * @return string
*/
function getType(){
trigger_error('getType() not implemented in '.get_class($this), E_USER_WARNING);
+ return '';
}
/**
@@ -31,6 +34,8 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
* Defines the mode types for other dokuwiki markup that maybe nested within the
* plugin's own markup. Needs to return an array of one or more of the mode types
* defined in $PARSER_MODES in parser.php
+ *
+ * @return array
*/
function getAllowedTypes() {
return array();
@@ -47,6 +52,7 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
* 'stack' - Special case. Plugin wraps other paragraphs.
*
* @see Doku_Handler_Block
+ * @return string
*/
function getPType(){
return 'normal';
@@ -99,7 +105,10 @@ class DokuWiki_Syntax_Plugin extends Doku_Parser_Mode_Plugin {
}
/**
- * There should be no need to override these functions
+ * There should be no need to override this function
+ *
+ * @param string $mode
+ * @return bool
*/
function accepts($mode) {