phpDocumentor phpDocumentor
[ class tree: phpDocumentor ] [ index: phpDocumentor ] [ all elements ]

Procedural File: ParserDescCleanup.inc

Source Location: /phpDocumentor/ParserDescCleanup.inc

Page Details

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

Author:  Gregory Beaver <cellog@php.net>
Version:  CVS: $Id: ParserDescCleanup.inc 286923 2009-08-08 06:00:39Z ashnazg $
Copyright:  2002-2006 Gregory Beaver
See:  Parser, WordParser
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Since:  1.2
License:  LGPL
Classes
Class Description
ObjectWordParser Like WordParser but designed to handle an array with strings and
parserDescParser Parses a DocBlock description to retrieve abstract representations of
Constants
PHPDOCUMENTOR_PDP_EVENT_B  [line 68]

PHPDOCUMENTOR_PDP_EVENT_B = 605

when <b> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_BR  [line 76]

PHPDOCUMENTOR_PDP_EVENT_BR = 607

when <br> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_CODE  [line 48]

PHPDOCUMENTOR_PDP_EVENT_CODE = 600

when <code> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_DOUBLECR  [line 56]

PHPDOCUMENTOR_PDP_EVENT_DOUBLECR = 602

when \n\n is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE  [line 80]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE = 608

when the << potential escape for tags is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE  [line 88]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE_CODE = 610

when << /code>> is found in a <code></code> section

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE  [line 84]

PHPDOCUMENTOR_PDP_EVENT_ESCAPE_PRE = 609

when << /pre>> is found in a <pre></pre> section

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_I  [line 72]

PHPDOCUMENTOR_PDP_EVENT_I = 606

when <i> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_KBD  [line 100]

PHPDOCUMENTOR_PDP_EVENT_KBD = 613

when <kbd> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_LIST  [line 64]

PHPDOCUMENTOR_PDP_EVENT_LIST = 604

when <ul>/<ol> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_P  [line 52]

PHPDOCUMENTOR_PDP_EVENT_P = 601

when <p> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_PRE  [line 60]

PHPDOCUMENTOR_PDP_EVENT_PRE = 603

when <pre> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_SAMP  [line 96]

PHPDOCUMENTOR_PDP_EVENT_SAMP = 612

when <samp> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_SIMLIST  [line 111]

PHPDOCUMENTOR_PDP_EVENT_SIMLIST = 614

when a simple list is found in a desc

parserDescParser token constants like

  o item 1
  o item 2


[ Top ]

PHPDOCUMENTOR_PDP_EVENT_VAR  [line 92]

PHPDOCUMENTOR_PDP_EVENT_VAR = 611

when <var> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_B  [line 70]

PHPDOCUMENTOR_PDP_STATE_B = 705

when <b> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_BR  [line 78]

PHPDOCUMENTOR_PDP_STATE_BR = 707

when <br> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_CODE  [line 50]

PHPDOCUMENTOR_PDP_STATE_CODE = 700

when <code> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_DOUBLECR  [line 58]

PHPDOCUMENTOR_PDP_STATE_DOUBLECR = 702

when \n\n is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_ESCAPE  [line 82]

PHPDOCUMENTOR_PDP_STATE_ESCAPE = 708

when the << potential escape for tags is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE  [line 90]

PHPDOCUMENTOR_PDP_STATE_ESCAPE_CODE = 710

when << /code>> is found in a <code></code> section

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE  [line 86]

PHPDOCUMENTOR_PDP_STATE_ESCAPE_PRE = 709

when << /pre>> is found in a <pre></pre> section

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_I  [line 74]

PHPDOCUMENTOR_PDP_STATE_I = 706

when <i> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_KBD  [line 102]

PHPDOCUMENTOR_PDP_STATE_KBD = 713

when <kbd> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_LIST  [line 66]

PHPDOCUMENTOR_PDP_STATE_LIST = 704

when <ul>/<ol> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_P  [line 54]

PHPDOCUMENTOR_PDP_STATE_P = 701

when <p> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_PRE  [line 62]

PHPDOCUMENTOR_PDP_STATE_PRE = 703

when <pre> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_SAMP  [line 98]

PHPDOCUMENTOR_PDP_STATE_SAMP = 712

when <samp> is found in a desc

parserDescParser token constants


[ Top ]

PHPDOCUMENTOR_PDP_STATE_SIMLIST  [line 120]

PHPDOCUMENTOR_PDP_STATE_SIMLIST = 714

when a simple list is found in a desc

parserDescParser token constants like

  o item 1
  o item 2


[ Top ]

PHPDOCUMENTOR_PDP_STATE_VAR  [line 94]

PHPDOCUMENTOR_PDP_STATE_VAR = 711

when <var> is found in a desc

parserDescParser token constants


[ Top ]



Documentation generated on Tue, 06 Dec 2011 07:20:40 -0600 by phpDocumentor 1.4.4