Guides

GuidesExtension.php

This file is part of phpDocumentor.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Tags
link
https://phpdoc.org

Table of Contents

Classes

GuidesExtension

Functions

templateArray()  : array<string|int, array{node: class-string, file: string, format: string}>
Helper function to configure multiple templates.
template()  : array{node: class-string, file: string, format: string}
Helper function to configure templates.

Functions

templateArray()

Helper function to configure multiple templates.

templateArray(array<class-string, string> $input[, string $format = 'html' ]) : array<string|int, array{node: class-string, file: string, format: string}>

This function is used to configure the templates in the configuration file.

Parameters
$input : array<class-string, string>
$format : string = 'html'
Return values
array<string|int, array{node: class-string, file: string, format: string}>

template()

Helper function to configure templates.

template(class-string $node, string $template[, string $format = 'html' ]) : array{node: class-string, file: string, format: string}

This function is used to configure the templates in the configuration file.

Parameters
$node : class-string
$template : string
$format : string = 'html'
Return values
array{node: class-string, file: string, format: string}
On this page

Search results