From 8e3a5477d12ec6c8413a09d966bf5a84c0666cab Mon Sep 17 00:00:00 2001
From: Andreas Gohr <andi@splitbrain.org>
Date: Sat, 24 May 2014 15:20:42 +0200
Subject: [PATCH] added short comment on how a renderer works
---
inc/parser/renderer.php | 6 ++++++
1 file changed, 6 insertions(+)
diff --git a/inc/parser/renderer.php b/inc/parser/renderer.php
index 5eddc903e..09294539e 100644
--- a/inc/parser/renderer.php
+++ b/inc/parser/renderer.php
@@ -11,6 +11,12 @@ if(!defined('DOKU_INC')) die('meh.');
* An empty renderer, produces no output
*
* Inherits from DokuWiki_Plugin for giving additional functions to render plugins
+ *
+ * The renderer transforms the syntax instructions created by the parser and handler into the
+ * desired output format. For each instruction a corresponding method defined in this class will
+ * be called. That method needs to produce the desired output for the instruction and add it to the
+ * $doc field. When all instructions are processed, the $doc field contents will be cached by
+ * DokuWiki and sent to the user.
*/
class Doku_Renderer extends DokuWiki_Plugin {
/** @var array Settings, control the behavior of the renderer */
--
GitLab