Description
Source Code Highlighting
The classes in this file are responsible for the dynamic @example, and <programlisting role="tutorial"> tags output. Using the WordParser, the phpDocumentor_TutorialHighlightParser retrieves PHP tokens one by one from the array generated by WordParser source retrieval functions and then highlights them individually.
It accomplishes this highlighting through the assistance of methods in the output Converter passed to its parse() method, and then returns the fully highlighted source as a string
phpDocumentor :: automatic documentation generator
PHP versions 4 and 5
Copyright (c) 2003-2007 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
- tutorial: - @example, @filesource
- author: - Gregory Beaver <[email protected]>
- version: - CVS: $Id: TutorialHighlightParser.inc 246148 2007-11-14 01:57:04Z ashnazg $
- copyright: - 2003-2007 Gregory Beaver
- link: - http://pear.php.net/PhpDocumentor
- link: - http://www.phpdoc.org
- todo: - CS cleanup - change package to PhpDocumentor
- todo: - CS cleanup - PHPCS needs to ignore CVS Id length
- since: - 1.3.0
- license: - LGPL
Classes defined in this file
CLASS NAME | DESCRIPTION |
| phpDocumentor_TutorialHighlightParser | Highlights source code using parse() |
STATE_TUTORIAL_ATTRIBUTE (line