ZenphotoCMS 1.6.3

pluginDoc.php

Displays a "plugin usage" document based on the plugin's doc comment block.

Supports the following PHPDoc markup tags: { @link URL text } text may be empty in which case the link is used as the link text. emphasis strong mono-spaced text code blocks (Note: PHPDocs will create an ordered list of the enclosed text)


horizontal rule
  • ,
    1. lists

      line break

      NOTE: These apply ONLY to the plugin's document block. Normal string use (e.g. plugin_notices, etc.). should use standard markup.

      The Zenphoto definitions for folder names and paths are represented by %define% (e.g. %WEBPATH%). The document processor will substitute the actual value for these tags when it renders the document. Image URIs are also processed. Use the appropriate Zenphoto definition tokens to cause the URI to point to the actual image. E.g.

Table of Contents

Constants

OFFSET_PATH  = 2

Functions

processCommentBlock()  : mixed

Constants

Functions

processCommentBlock()

processCommentBlock(mixed $commentBlock) : mixed
Parameters
$commentBlock : mixed

        
On this page

Search results