Xinc-Plugin-Repos
[ class tree: Xinc-Plugin-Repos ] [ index: Xinc-Plugin-Repos ] [ all elements ]

Class: Xinc_Plugin_Repos_Documentation

Source Location: /Xinc/Plugin/Repos/Documentation.php

Class Overview

Xinc_Plugin_Base
   |
   --Xinc_Plugin_Repos_Documentation



Constants

Methods


Inherited Methods

Class: Xinc_Plugin_Base

Xinc_Plugin_Base::getApiModules()
Xinc_Plugin_Base::getGuiWidgets()
Xinc_Plugin_Base::getTaskDefinitions()
Returns the defined tasks of the plugin
Xinc_Plugin_Base::validate()
Validate if the plugin can run properly on this system

Class Details

[line 34]


[ Top ]


Class Methods


method getApiModules [line 57]

void getApiModules( )



Tags:

access:  public


Overrides Xinc_Plugin_Base::getApiModules() (parent method not documented)

[ Top ]

method getDocumentationDir [line 62]

void getDocumentationDir( Xinc_Build_Interface $build)



Tags:

access:  public


Parameters:

Xinc_Build_Interface   $build  

[ Top ]

method getGuiWidgets [line 52]

array getGuiWidgets( )



Tags:

return:  of Gui Widgets
access:  public


Overrides Xinc_Plugin_Base::getGuiWidgets() (parent method not documented)

[ Top ]

method getTaskDefinitions [line 43]

void getTaskDefinitions( )



Tags:

access:  public


Overrides Xinc_Plugin_Base::getTaskDefinitions() (Returns the defined tasks of the plugin)

[ Top ]

method registerDocumentation [line 79]

boolean registerDocumentation( Xinc_Build_Interface $build, string $sourceFile, $alias, $index)

Copies a file into a special artifacts directory for the build



Tags:

access:  public


Parameters:

Xinc_Build_Interface   $build  
string   $sourceFile  
   $alias  
   $index  

[ Top ]

method validate [line 38]

void validate( )



Tags:

access:  public


Overrides Xinc_Plugin_Base::validate() (Validate if the plugin can run properly on this system)

[ Top ]


Class Constants

DOCUMENTATION_DIR =  'documentation'

[line 36]


[ Top ]



Documentation generated on Sun, 09 Dec 2012 21:49:25 +0100 by phpDocumentor 1.4.4