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

Recommend this page to a friend!
  Classes of Francesco Danti  >  Sphinx PHP Doc RST  >  docs/_build/html/_sources/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.rst.txt  >  Download  
File: docs/_build/html/_sources/api/JuliusHaertl/PHPDocToRst/Builder/FileBuilder.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: 2,975 bytes
 

Contents

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

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


FileBuilder
===========


.. php:namespace:: JuliusHaertl\PHPDocToRst\Builder

.. rst-class::  abstract

.. php:class:: FileBuilder


	.. rst-class:: phpdoc-description
	
		| Abstract building class to build sphinxcontrib\-phpdomain from a php file\.
		
	
	:Source:
		`/Builder/FileBuilder.php#30 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L30>`_
	
	:Parent:
		:php:class:`JuliusHaertl\\PHPDocToRst\\Builder\\PhpDomainBuilder`
	


Summary
-------

Methods
~~~~~~~

* :php:meth:`public \_\_construct\($file, $element, $extensions\)<JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder::\_\_construct\(\)>`
* :php:meth:`protected abstract render\(\)<JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder::render\(\)>`
* :php:meth:`public getElement\(\)<JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder::getElement\(\)>`
* :php:meth:`public getFile\(\)<JuliusHaertl\\PHPDocToRst\\Builder\\FileBuilder::getFile\(\)>`


Properties
----------

.. php:attr:: protected static file

	:Source:
		`/Builder/FileBuilder.php#33 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L33>`_
	
	:Type: :any:`\\phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>` 


.. php:attr:: protected static element

	:Source:
		`/Builder/FileBuilder.php#36 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L36>`_
	
	:Type: :any:`\\phpDocumentor\\Reflection\\Element <phpDocumentor\\Reflection\\Element>` 


.. php:attr:: protected static extensions

	:Source:
		`/Builder/FileBuilder.php#39 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L39>`_
	
	:Type: :any:`\\JuliusHaertl\\PHPDocToRst\\Extension\\Extension\[\] <JuliusHaertl\\PHPDocToRst\\Extension\\Extension>` 


Methods
-------

.. rst-class:: public

	.. php:method:: public __construct( $file, $element, $extensions)
	
		:Source:
			`/Builder/FileBuilder.php#41 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L41>`_
		
		
	
	

.. rst-class:: protected abstract

	.. php:method:: protected abstract render()
	
		:Source:
			`/Builder/FileBuilder.php#49 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L49>`_
		
		
	
	

.. rst-class:: public

	.. php:method:: public getElement()
	
		:Source:
			`/Builder/FileBuilder.php#54 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L54>`_
		
		
		:Returns: :any:`\\phpDocumentor\\Reflection\\Element <phpDocumentor\\Reflection\\Element>` that is used to build the rst file
	
	

.. rst-class:: public

	.. php:method:: public getFile()
	
		:Source:
			`/Builder/FileBuilder.php#62 <http://github.com/abbadon1334/phpdoc-to-rst//blob/master//Builder/FileBuilder.php#L62>`_
		
		
		:Returns: :any:`\\phpDocumentor\\Reflection\\Php\\File <phpDocumentor\\Reflection\\Php\\File>` 
	
	


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