• Accueil
• Solar_Cli_MakeDocs

PHP Class Solar_Cli_MakeDocs, php-framework-benchmarks

Afficher le fichier Open project: pmjones/php-framework-benchmarks

Méthodes publiques

Свойство	Type	Description
$api	array	The entire API as a data set.
$packages	array	All package groupings as a data set.

Protected Properties

Свойство	Type	Description
$_Solar_Cli_MakeDocs	array	Default configuration values.
$_class_dir	string	Write class API files to this directory.
$_classes_list	array	Summary list of all classes.
$_docbook_dir	string	Write DocBook files to this directory.
$_package_dir	string	Write package files to this directory.
$_source	string	The source code directory, typically the 'include' directory.

Méthodes publiques

Méthode	Description
writeClassConfig ( string $class ) : void	Writes the Config file.
writeClassConstants ( string $class ) : void	Writes the Constants file.
writeClassIndex ( string $class ) : void	Writes the index file for a single class.
writeClassMethod ( string $class, string $name, array $info ) : void	Writes an individual method file.
writeClassMethods ( string $class ) : void	Writes the Methods file.
writeClassOverview ( string $class ) : void	Writes the Overview file.
writeClassProperties ( string $class ) : void	Writes the Properties file.
writeClasses ( ) : void	Writes the "class" directory.
writeClassesIndex ( ) : void	Writes the index file for the list of classes.
writePackageClassList ( string $package ) : void	Writes one package description file.
writePackageIndex ( ) : void	Writes the package index file.
writePackages ( ) : void	Writes the entire "packages" directory.

Méthodes protégées

Méthode	Description
_exec ( string $class = null ) : void	Main action: parse the classes and write documentation.
_getFile ( string $type, string $file ) : string	Builds a target filename path in the 'class' or 'package' directory.
_postConstruct ( ) : void	Post-construction tasks to complete object construction.
_title1 ( string $text ) : string	Returns level-1 title markup.
_title2 ( string $text ) : string	Returns level-2 title markup.
_title3 ( string $text ) : string	Returns level-3 title markup.
_touch ( string $type, string $file ) : void	Touches a file to create it or update its timestamp.
_write ( string $type, string $file, mixed $text ) : void	Writes a file to the target directory.

Method Details

Property Details