PEAR2_Text_Markdown › PEAR2_Text_Markdown-0.1.0/php/PEAR2/Text/Markdown/Apidoc/MethodSynopsis.php

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
<?php
/**
 * 
 * Block plugin to for method synopsis markup.
 * 
 *     {{method: methodName
 *        @access level
 *        @param  type
 *        @param  type, name,
 *        @param  type, name, default
 *        @return type
 *        @throws type
 *        @throws type
 *     }}
 * 
 * @category Solar
 * 
 * @package Markdown_Apidoc
 * 
 * @author Paul M. Jones <pmjones@solarphp.com>
 * 
 * @license http://opensource.org/licenses/bsd-license.php BSD
 * 
 * @version $Id: MethodSynopsis.php 4600 2010-06-16 03:27:55Z pmjones $
 * 
 */
namespace PEAR2\Text;

class Markdown_Apidoc_MethodSynopsis extends Markdown_Wiki_MethodSynopsis
{
    /**
     * 
     * Default configuration values.
     * 
     * @config string synopsis The "main" format string.
     * 
     * @config string access The format string for access type.
     * 
     * @config string return The format string for return type.
     * 
     * @config string method The format string for the method name.
     * 
     * @config string param The format string for required params.
     * 
     * @config string param_default The format string for params with a default value.
     * 
     * @config string param_void The format string for a method with no params.
     * 
     * @config string throws The format string for throws.
     * 
     * @config string list_sep The list separator for params and throws.
     * 
     * @var array
     * 
     */
    protected $_Markdown_Apidoc_MethodSynopsis = array(
        'synopsis'      => "<methodsynopsis>\n    %access\n    %return\n    %method %params\n    %throws\n</methodsynopsis>",
        'access'        => '<modifier>%access</modifier>',
        'return'        => '<type>%return</type>',
        'method'        => '<methodname>%method</methodname>',
        'param'         => "\n        <methodparam><type>%type</type> <parameter>%name</parameter></methodparam>",
        'param_default' => "\n        <methodparam><type>%type</type> <parameter>%name</parameter> <initializer>%default</initializer></methodparam>",
        'param_void'    => "<void />",
        'throws'        => "\n    <exceptionname>%type</exceptionname>",
        'list_sep'      => '',
    );
}
EOF