Merge pull request #3074 from aanbar/output_documentation

Added _display documentation.

1 files changed, 25 insertions, 1 deletions

diff --git a/user_guide_src/source/libraries/output.rst b/user_guide_src/source/libraries/output.rst
index e49ea5366..218ec5896 100644
--- a/user_guide_src/source/libraries/output.rst
+++ b/user_guide_src/source/libraries/output.rst
@@ -205,4 +205,28 @@ Class Reference
 
 		Caches the current page for the specified amount of seconds.
 
-		For more information, please see the :doc:`caching documentation <../general/caching>`.
\ No newline at end of file
+		For more information, please see the :doc:`caching documentation <../general/caching>`.
+
+	.. method:: _display([$output = ''])
+
+		:param	string	$output: Output data override
+		:returns:	void
+		:rtype:	void
+
+		Sends finalized output data to the browser along with any server headers. It also stops benchmark
+		timers.
+
+		.. note:: This method is called automatically at the end of script execution, you won't need to 
+			call it manually unless you are aborting script execution using ``exit()`` or ``die()`` in your code.
+		
+		Example::
+			$response = array('status' => 'OK');
+
+			$this->output
+				->set_status_header(200)
+				->set_content_type('application/json', 'utf-8')
+				->set_output(json_encode($response, JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES))
+				->_display();
+			exit;
+
+		.. note:: Calling this method manually without aborting script execution will result in duplicated output.
\ No newline at end of file