/phpDocumentor/ParserDescCleanup.inc
All of the functions to clean up and handle the long description of a DocBlock are in this file.
The primary functionality is based on Parser and WordParser, and modified to recognize only the tokens defined in the PHPDOCUMENTOR_PDP_* constants
phpDocumentor :: automatic documentation generator
PHP versions 4 and 5
Copyright (c) 2002-2006 Gregory Beaver
LICENSE:
This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation; either version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
| Class | Description |
|---|---|
ObjectWordParser
|
Like WordParser but designed to handle an array with strings and |
|
parserDescParser
|
Parses a DocBlock description to retrieve abstract representations of |
PHPDOCUMENTOR_PDP_EVENT_B = 605
(line 68)
when <b> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_BR = 607
(line 76)
when <br> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_CODE = 600
(line 48)
when <code> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_DOUBLECR = 602
(line 56)
when \n\n is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_ESCAPE = 608
(line 80)
when the << potential escape for tags is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE = 610
(line 88)
when << /code>> is found in a <code></code> section
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE = 609
(line 84)
when << /pre>> is found in a <pre></pre> section
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_I = 606
(line 72)
when <i> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_KBD = 613
(line 100)
when <kbd> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_LIST = 604
(line 64)
when <ul>/<ol> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_P = 601
(line 52)
when <p> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_PRE = 603
(line 60)
when <pre> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_SAMP = 612
(line 96)
when <samp> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_EVENT_SIMLIST = 614
(line 111)
when a simple list is found in a desc
parserDescParser token constants like
o item 1 o item 2
PHPDOCUMENTOR_PDP_EVENT_VAR = 611
(line 92)
when <var> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_B = 705
(line 70)
when <b> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_BR = 707
(line 78)
when <br> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_CODE = 700
(line 50)
when <code> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_DOUBLECR = 702
(line 58)
when \n\n is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_ESCAPE = 708
(line 82)
when the << potential escape for tags is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE = 710
(line 90)
when << /code>> is found in a <code></code> section
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE = 709
(line 86)
when << /pre>> is found in a <pre></pre> section
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_I = 706
(line 74)
when <i> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_KBD = 713
(line 102)
when <kbd> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_LIST = 704
(line 66)
when <ul>/<ol> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_P = 701
(line 54)
when <p> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_PRE = 703
(line 62)
when <pre> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_SAMP = 712
(line 98)
when <samp> is found in a desc
parserDescParser token constants
PHPDOCUMENTOR_PDP_STATE_SIMLIST = 714
(line 120)
when a simple list is found in a desc
parserDescParser token constants like
o item 1 o item 2
PHPDOCUMENTOR_PDP_STATE_VAR = 711
(line 94)
when <var> is found in a desc
parserDescParser token constants
Documentation generated on Mon, 05 Dec 2011 21:06:17 -0600 by phpDocumentor 1.4.4