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

Procedural File: HighlightParser.inc

Source Location: /phpDocumentor/HighlightParser.inc

Page Details

Source Code Highlighting

The classes in this file are responsible for the dynamic @example, @filesource and {@source} tags output. Using the phpDocumentor_HighlightWordParser, the phpDocumentor_HighlightParser retrieves PHP tokens one by one from the array generated by phpDocumentorTWordParser 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) 2002-2008 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, inline {@source}
Author:  Gregory Beaver <cellog@php.net>
Version:  CVS: $Id: HighlightParser.inc 253641 2008-02-24 02:35:44Z ashnazg $
Copyright:  2002-2008 Gregory Beaver
Link:  http://pear.php.net/PhpDocumentor
Link:  http://www.phpdoc.org
Todo:  CS cleanup - change package to PhpDocumentor
Since:  1.2.0beta3
Filesource:  Source Code for this file
License:  LGPL
Classes
Class Description
phpDocumentor_HighlightWordParser Retrieve tokens from an array of tokens organized by line numbers
phpDocumentor_HighlightParser Highlights source code using parse()

Documentation generated on Tue, 06 Dec 2011 07:18:27 -0600 by phpDocumentor 1.4.4