File: docs/_build/html/_sources/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst.txt

Recommend this page to a friend!
  Classes of Francesco Danti  >  Sphinx PHP Doc RST  >  docs/_build/html/_sources/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst.txt  >  Download  
File: docs/_build/html/_sources/api/JuliusHaertl/PHPDocToRst/Extension/Extension.rst.txt
Role: Documentation
Content type: text/plain
Description: Documentation
Class: Sphinx PHP Doc RST
Generate Sphinx documentation from PHPDoc comments
Author: By
Last change:
Date: 11 months ago
Size: 3,815 bytes
 

Contents

Class file image Download
.. rst-class:: phpdoctorst

.. role:: php(code)
	:language: php


Extension
=========


.. php:namespace:: JuliusHaertl\PHPDocToRst\Extension

.. rst-class::  abstract

.. php:class:: Extension


	:Source:
		`/Extension/Extension.php#27 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L27>`_
	


Summary
-------

Methods
~~~~~~~

* :php:meth:`public \_\_construct\($project, $arguments\)<JuliusHaertl\\PHPDocToRst\\Extension\\Extension::\_\_construct\(\)>`
* :php:meth:`public prepare\(\)<JuliusHaertl\\PHPDocToRst\\Extension\\Extension::prepare\(\)>`
* :php:meth:`public render\($type, $builder, $element\)<JuliusHaertl\\PHPDocToRst\\Extension\\Extension::render\(\)>`
* :php:meth:`public shouldRenderElement\($element\)<JuliusHaertl\\PHPDocToRst\\Extension\\Extension::shouldRenderElement\(\)>`
* :php:meth:`public shouldRenderIndex\($type, $element\)<JuliusHaertl\\PHPDocToRst\\Extension\\Extension::shouldRenderIndex\(\)>`


Properties
----------

.. php:attr:: protected static project

	:Source:
		`/Extension/Extension.php#30 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L30>`_
	
	:Type: :any:`\\phpDocumentor\\Reflection\\Php\\Project <phpDocumentor\\Reflection\\Php\\Project>` 


.. php:attr:: protected static arguments

	:Source:
		`/Extension/Extension.php#33 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L33>`_
	
	:Type: array 


Methods
-------

.. rst-class:: public

	.. php:method:: public __construct( $project, $arguments=\[\])
	
		:Source:
			`/Extension/Extension.php#35 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L35>`_
		
		
	
	

.. rst-class:: public

	.. php:method:: public prepare()
	
		.. rst-class:: phpdoc-description
		
			| Method that will be ran before generating any documentation files
			| This is useful for preparing own data structures
			| to be used in the output documentation\.
			
		
		:Source:
			`/Extension/Extension.php#46 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L46>`_
		
		
	
	

.. rst-class:: public

	.. php:method:: public render( $type, &$builder, $element)
	
		.. rst-class:: phpdoc-description
		
			| Implement custom rendering functionality here\.
			
			| It will be executed by Builder classes depending on the given type\.
			| 
			| Currently supported types:
			| 
			|  \- PhpDomainBuilder::SECTION\_BEFORE\_DESCRIPTION
			|  \- PhpDomainBuilder::SECTION\_AFTER\_DESCRIPTION
			
		
		:Source:
			`/Extension/Extension.php#63 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L63>`_
		
		
		:Parameters:
			* **$type** (string)  
			* **$builder** (:any:`JuliusHaertl\\PHPDocToRst\\Builder\\ExtensionBuilder <JuliusHaertl\\PHPDocToRst\\Builder\\ExtensionBuilder>`)  
			* **$element** (:any:`phpDocumentor\\Reflection\\Element <phpDocumentor\\Reflection\\Element>`)  context for the render type

		
	
	

.. rst-class:: public

	.. php:method:: public shouldRenderElement( $element)
	
		.. rst-class:: phpdoc-description
		
			| This method will be called to check if a certain element should
			| be rendered in the documentation\.
			
			| An example extension that makes use of it is PublicOnlyExtension
			
		
		:Source:
			`/Extension/Extension.php#77 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L77>`_
		
		
		:Parameters:
			* **$element** (:any:`phpDocumentor\\Reflection\\Element <phpDocumentor\\Reflection\\Element>`)  

		
		:Returns: bool 
	
	

.. rst-class:: public

	.. php:method:: public shouldRenderIndex( $type, $element)
	
		:Source:
			`/Extension/Extension.php#82 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Extension/Extension.php#L82>`_
		
		
	
	


For more information send a message to info at phpclasses dot org.