Overview

Package

This class is part of the Solar_Markdown_Apidoc package.

Inheritance:

• Solar_Base

  • Solar_Markdown_Plugin

    • Solar_Markdown_Wiki_MethodSynopsis

      • Solar_Markdown_Apidoc_MethodSynopsis

Configuration Keys

• markdown: The "parent" Markdown object.

• synopsis: The "main" format string.

• access: The format string for access type.

• return: The format string for return type.

• method: The format string for the method name.

• param: The format string for required params.

• param_default: The format string for params with a default value.

• param_void: The format string for a method with no params.

• throws: The format string for throws.

• list_sep: The list separator for params and throws.

Constants

None.

Public Properties

The Solar_Markdown_Apidoc_MethodSynopsis class has no public properties; try the list of all properties.

Public Methods

These are all the public methods in the Solar_Markdown_Apidoc_MethodSynopsis class.

You can also view the list of all public, protected, and private methods.

__construct()

Constructor.

__destruct()

Default destructor; does nothing other than provide a safe fallback for calls to parent::__destruct().

cleanup()

Cleans up the source text after all parsing occurs.

dump()

Convenience method for getting a dump the whole object, or one of its properties, or an external variable.

getChars()

Get the list of characters this plugin uses for parsing.

isBlock()

Is this a block-level plugin?

isCleanup()

Run this plugin during the "cleanup" phase?

isPrepare()

Run this plugin during the "prepare" phase?

isSpan()

Is this a span-level plugin?

locale()

Looks up class-specific locale strings based on a key.

parse()

Converts method synopsis to XHTML markup.

prepare()

Prepares the source text before any parsing occurs.

reset()

Resets this plugin to its original state (for multiple parsings).

setMarkdown()

Sets the "parent" Markdown object.