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

Procedural File:

Source Location: /phpDocumentor/

Page Details

All abstract representations of html tags in DocBlocks are handled by the classes in this file

Before version 1.2, phpDocumentor simply passed html to converters, without much thought, except the adv_htmlentities() function was provided along with a list of allowed html. That list is no longer used, in favor of these classes.

The PDF Converter output looked wretched in version 1.1.0 because line breaks in DocBlocks were honored. This meant that output often had just a few words on every other line! To fix this problem, DocBlock descriptions are now parsed using the ParserDescParser, and split into paragraphs. In addition, html in DocBlocks are parsed into these objects to allow for easy conversion in destination converters. This design also allows different conversion for different templates within a converter, which separates design from logic almost 100%

phpDocumentor :: automatic documentation generator

PHP versions 4 and 5

Copyright (c) 2002-2006 Gregory Beaver


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

See:  parserDocBlock, parserInclude, parserPage, parserClass
See:  parserDefine, parserFunction, parserMethod, parserVar
Since:  1.2
Filesource:  Source Code for this file
Copyright:  2002-2006 Gregory Beaver
License:  LGPL
Version:  CVS: $Id:,v 1.3 2006/04/30 22:18:13 cellog Exp $
Author:  Greg Beaver <[email protected]>
Class Description
parserCode Used for <code> in a description
parserPre Used for <pre> in a description
parserB Used for <b> in a description
parserI Used for <i> in a description
parserDescVar Used for <var> in a description
parserSamp Used for <samp> in a description
parserKbd Used for <kbd> in a description
parserBr Used for <br> in a description
parserList Used for lists <ol> and <ul>

Documentation generated on Tue, 24 Oct 2006 09:22:03 -0500 by phpDocumentor 1.3.1