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 |
when <b> is found in a desc
parserDescParser token constants
when <br> is found in a desc
parserDescParser token constants
when <code> is found in a desc
parserDescParser token constants
when \n\n is found in a desc
parserDescParser token constants
when the << potential escape for tags is found in a desc
parserDescParser token constants
when << /code>> is found in a <code></code> section
parserDescParser token constants
when << /pre>> is found in a <pre></pre> section
parserDescParser token constants
when <i> is found in a desc
parserDescParser token constants
when <kbd> is found in a desc
parserDescParser token constants
when <ul>/<ol> is found in a desc
parserDescParser token constants
when <p> is found in a desc
parserDescParser token constants
when <pre> is found in a desc
parserDescParser token constants
when <samp> is found in a desc
parserDescParser token constants
when a simple list is found in a desc
parserDescParser token constants like
o item 1 o item 2
when <var> is found in a desc
parserDescParser token constants
when <b> is found in a desc
parserDescParser token constants
when <br> is found in a desc
parserDescParser token constants
when <code> is found in a desc
parserDescParser token constants
when \n\n is found in a desc
parserDescParser token constants
when the << potential escape for tags is found in a desc
parserDescParser token constants
when << /code>> is found in a <code></code> section
parserDescParser token constants
when << /pre>> is found in a <pre></pre> section
parserDescParser token constants
when <i> is found in a desc
parserDescParser token constants
when <kbd> is found in a desc
parserDescParser token constants
when <ul>/<ol> is found in a desc
parserDescParser token constants
when <p> is found in a desc
parserDescParser token constants
when <pre> is found in a desc
parserDescParser token constants
when <samp> is found in a desc
parserDescParser token constants
when a simple list is found in a desc
parserDescParser token constants like
o item 1 o item 2
when <var> is found in a desc
parserDescParser token constants
Documentation generated on Mon, 05 Dec 2011 21:23:04 -0600 by phpDocumentor 1.4.4