--- /dev/null
+# Doxyfile 1.3.6
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME = SPL - Standard PHP Library
+PROJECT_NUMBER =
+OUTPUT_DIRECTORY =
+OUTPUT_LANGUAGE = English
+USE_WINDOWS_ENCODING = YES
+BRIEF_MEMBER_DESC = YES
+REPEAT_BRIEF = YES
+ABBREVIATE_BRIEF =
+ALWAYS_DETAILED_SEC = NO
+INLINE_INHERITED_MEMB = NO
+FULL_PATH_NAMES = NO
+STRIP_FROM_PATH =
+SHORT_NAMES = NO
+JAVADOC_AUTOBRIEF = YES
+MULTILINE_CPP_IS_BRIEF = YES
+DETAILS_AT_TOP = NO
+INHERIT_DOCS = YES
+DISTRIBUTE_GROUP_DOC = NO
+TAB_SIZE = 8
+ALIASES =
+OPTIMIZE_OUTPUT_FOR_C = NO
+OPTIMIZE_OUTPUT_JAVA = NO
+SUBGROUPING = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL = YES
+EXTRACT_PRIVATE = YES
+EXTRACT_STATIC = YES
+EXTRACT_LOCAL_CLASSES = YES
+HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_CLASSES = NO
+HIDE_FRIEND_COMPOUNDS = NO
+HIDE_IN_BODY_DOCS = NO
+INTERNAL_DOCS = YES
+CASE_SENSE_NAMES = YES
+HIDE_SCOPE_NAMES = NO
+SHOW_INCLUDE_FILES = YES
+INLINE_INFO = YES
+SORT_MEMBER_DOCS = YES
+SORT_BRIEF_DOCS = YES
+SORT_BY_SCOPE_NAME = NO
+GENERATE_TODOLIST = YES
+GENERATE_TESTLIST = YES
+GENERATE_BUGLIST = YES
+GENERATE_DEPRECATEDLIST= YES
+ENABLED_SECTIONS =
+MAX_INITIALIZER_LINES = 30
+SHOW_USED_FILES = YES
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET = NO
+WARNINGS = YES
+WARN_IF_UNDOCUMENTED = YES
+WARN_IF_DOC_ERROR = YES
+WARN_FORMAT = "$file:$line: $text"
+WARN_LOGFILE =
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT = spl.php examples
+FILE_PATTERNS = *.inc *.php
+RECURSIVE = NO
+EXCLUDE =
+EXCLUDE_SYMLINKS = NO
+EXCLUDE_PATTERNS =
+EXAMPLE_PATH =
+EXAMPLE_PATTERNS =
+EXAMPLE_RECURSIVE = NO
+IMAGE_PATH =
+INPUT_FILTER =
+FILTER_SOURCE_FILES = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER = NO
+INLINE_SOURCES = NO
+STRIP_CODE_COMMENTS = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION = YES
+VERBATIM_HEADERS = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX = NO
+COLS_IN_ALPHA_INDEX = 5
+IGNORE_PREFIX =
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+GENERATE_HTML = YES
+HTML_OUTPUT = html
+HTML_FILE_EXTENSION = .html
+HTML_HEADER =
+HTML_FOOTER =
+HTML_STYLESHEET =
+HTML_ALIGN_MEMBERS = YES
+GENERATE_HTMLHELP = YES
+CHM_FILE = ../spl.chm
+HHC_LOCATION = hhc.exe
+GENERATE_CHI = NO
+BINARY_TOC = NO
+TOC_EXPAND = NO
+DISABLE_INDEX = NO
+ENUM_VALUES_PER_LINE = 4
+GENERATE_TREEVIEW = NO
+TREEVIEW_WIDTH = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX = NO
+LATEX_OUTPUT = latex
+LATEX_CMD_NAME = latex
+MAKEINDEX_CMD_NAME = makeindex
+COMPACT_LATEX = NO
+PAPER_TYPE = a4wide
+EXTRA_PACKAGES =
+LATEX_HEADER =
+PDF_HYPERLINKS = NO
+USE_PDFLATEX = NO
+LATEX_BATCHMODE = NO
+LATEX_HIDE_INDICES = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF = NO
+RTF_OUTPUT = rtf
+COMPACT_RTF = NO
+RTF_HYPERLINKS = NO
+RTF_STYLESHEET_FILE =
+RTF_EXTENSIONS_FILE =
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN = NO
+MAN_OUTPUT = man
+MAN_EXTENSION = .3
+MAN_LINKS = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML = YES
+XML_OUTPUT = xml
+XML_SCHEMA =
+XML_DTD =
+XML_PROGRAMLISTING = YES
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD = NO
+PERLMOD_LATEX = NO
+PERLMOD_PRETTY = YES
+PERLMOD_MAKEVAR_PREFIX =
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING = YES
+MACRO_EXPANSION = NO
+EXPAND_ONLY_PREDEF = NO
+SEARCH_INCLUDES = YES
+INCLUDE_PATH =
+INCLUDE_FILE_PATTERNS =
+PREDEFINED =
+EXPAND_AS_DEFINED =
+SKIP_FUNCTION_MACROS = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to external references
+#---------------------------------------------------------------------------
+TAGFILES =
+GENERATE_TAGFILE =
+ALLEXTERNALS = NO
+EXTERNAL_GROUPS = YES
+PERL_PATH = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS = YES
+HIDE_UNDOC_RELATIONS = YES
+HAVE_DOT = NO
+CLASS_GRAPH = YES
+COLLABORATION_GRAPH = YES
+UML_LOOK = NO
+TEMPLATE_RELATIONS = NO
+INCLUDE_GRAPH = YES
+INCLUDED_BY_GRAPH = YES
+CALL_GRAPH = NO
+GRAPHICAL_HIERARCHY = YES
+DOT_IMAGE_FORMAT = png
+DOT_PATH =
+DOTFILE_DIRS =
+MAX_DOT_GRAPH_WIDTH = 1024
+MAX_DOT_GRAPH_HEIGHT = 1024
+MAX_DOT_GRAPH_DEPTH = 0
+GENERATE_LEGEND = YES
+DOT_CLEANUP = YES
+#---------------------------------------------------------------------------
+# Configuration::additions related to the search engine
+#---------------------------------------------------------------------------
+SEARCHENGINE = NO
<?php
-/** \ingroup Examples
+/** @file appenditerator.inc
+ * @ingroup Examples
+ * @brief class AppendIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief Iterator that iterates over several iterators one after the other
* @author Marcus Boerger
* @version 1.0
<?php
+/** @file autoload.inc
+ * @ingroup Examples
+ * @brief function __autoload
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
/** \internal
* Tries to load class $classname from directory $dir.
*/
<?php
-/** dba array utility
+/** @file dba_array.php
+ * @brief Program DBA array utility
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage php dba_array.php <file> <handler> <key> [<value>]
+ * Usage php dba_array.php \<file\> \<handler\> \<key\> [\<value\>]
*
- * If <value> is specified then <key> is set to <value> in <file>.
- * Else the value of <key> is printed only.
+ * If \<value\> is specified then \<key\> is set to \<value\> in \<file\>.
+ * Else the value of \<key\> is printed only.
*
* Note: configure with --enable-dba
- *
- * (c) Marcus Boerger, 2003 - 2004
*/
if ($argc < 4) {
<?php
-/** dba dump utility
+/** @file dba_dump.php
+ * @brief Program DBA dump utility
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage: php dba_dump.php <file> <handler> [<regex>]
+ * Usage: php dba_dump.php \<file\> \<handler\> [\<regex\>]
*
- * Show all groups in the ini file specified by <file>.
- * The regular expression <regex> is used to filter the by setting name.
+ * Show all groups in the ini file specified by \<file\>.
+ * The regular expression \<regex\> is used to filter the by setting name.
*
* Note: configure with --enable-dba
- *
- * (c) Marcus Boerger, 2003 - 2004
*/
if ($argc < 3) {
<?php
+/** @file dbaarray.inc
+ * @ingroup Examples
+ * @brief class DbaArray
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
if (!class_exists("DbaReader")) require_once("dbareader.inc");
-/** \ingroup Examples
+/** @ingroup Examples
* @brief This implements a DBA Array
* @author Marcus Boerger
* @version 1.0
<?php
-/** \ingroup Examples
+/** @file dbareader.inc
+ * @ingroup Examples
+ * @brief class DbaReader
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief This implements a DBA Iterator.
* @author Marcus Boerger
* @version 1.0
<?php
-/** \ingroup Examples
+/** @file directoryfilterdots.inc
+ * @ingroup Examples
+ * @brief class DirectoryFilterDots
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief A filtered DirectoryIterator
* @author Marcus Boerger
* @version 1.0
<?php
-/** \ingroup Examples
+/** @file directorytree.inc
+ * @ingroup Examples
+ * @brief class DirectoryTree
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief A directory iterator that does not show '.' and '..'.
* @author Marcus Boerger
* @version 1.0
<?php
-if (!class_exists('DirectoryTreeIterator', false)) {
- require_once(dirname(__FILE__). '/directorytreeiterator.inc');
-}
-
-/** tree view example
+/** @file directorytree.php
+ * @brief Program Directory tree example
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage: php directorytree.php <path> [<start> [<count>]]
+ * Usage: php directorytree.php \<path\> [\<start\> [\<count\>]]
*
- * Simply specify the path to tree with parameter <path>.
- *
- * (c) Marcus Boerger, 2003
+ * Simply specify the path to tree with parameter \<path\>.
*/
if ($argc < 2) {
exit(1);
}
+if (!class_exists("DirectoryTreeIterator")) require_once("directorytreeiterator.inc");
+
$length = $argc > 3 ? $argv[3] : -1;
echo $argv[1]."\n";
<?php
-/** \ingroup Examples
+/** @file directorytreeiterator.inc
+ * @ingroup Examples
+ * @brief class DirectoryTreeIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief DirectoryIterator to generate ASCII graphic directory trees
* @author Marcus Boerger
* @version 1.0
<?php
-/** \ingroup Examples
+/** @file emptyiterator.inc
+ * @ingroup Examples
+ * @brief class EmptyIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief An empty Iterator
* @author Marcus Boerger
* @version 1.0
<?php
+/** @file findfile.inc
+ * @ingroup Examples
+ * @brief class FindFile
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
if (!class_exists("FindFile")) require_once("findfile.inc");
if (!class_exists("AppendIterator")) require_once("appenditerator.inc");
-/**
+/** @ingroup Examples
* @brief Base class to find files
* @author Marcus Boerger
* @version 1.1
<?php
-/** Find a specific file by name.
+/** @file findfile.php
+ * @brief Program Find a specific file by name.
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage: php findfile.php <path> <name>
+ * Usage: php findfile.php \<path\> \<name\>
*
- * <path> Path to search in. You can specify multiple paths by separating
+ * \<path\> Path to search in. You can specify multiple paths by separating
* them with ';'.
- * <name> Filename to look for.
- *
- * (c) Marcus Boerger, 2003 - 2004
+ * \<name\> Filename to look for.
*/
if ($argc < 3) {
exit(1);
}
+if (!class_exists("FindFile")) require_once("findfile.inc");
+
foreach(new FindFile($argv[1], $argv[2]) as $file) echo $file->getPathname()."\n";
?>
\ No newline at end of file
<?php
-/** Find a specific file by name.
+/** @file findregex.php
+ * @brief Program Find a specific file by name.
+ * @ingroup Examples
+ * @author Marcus Boerger, Adam Trachtenberg
+ * @date 2004
*
- * Usage: php findregex.php <path> <name>
+ * Usage: php findregex.php \<path\> \<name\>
*
- * <path> Path to search in.
- * <name> Filename to look for.
- *
- * (c) Marcus Boerger, Adam Trachtenberg, 2004
+ * \<path\> Path to search in.
+ * \<name\> Filename to look for.
*/
if ($argc < 3) {
<?php
-/** \ingroup Examples
+/** @file infiniteiterator.inc
+ * @ingroup Examples
+ * @brief class InfiniteIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief An infinite Iterator
* @author Marcus Boerger
* @version 1.0
<?php
-/** List groups within an ini file
+/** @file ini_groups.php
+ * @brief Program List groups within an ini file
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage: php dba_dump.php <file> [<regex>]
+ * Usage: php dba_dump.php \<file\> [\<regex\>]
*
- * Show all groups in the ini file specified by <file>.
- * The regular expression <regex> is used to filter the result.
+ * Show all groups in the ini file specified by \<file\>.
+ * The regular expression \<regex\> is used to filter the result.
*
* Note: configure with --enable-dba
- *
- * (c) Marcus Boerger, 2003 - 2004
*/
if ($argc < 2) {
<?php
+/** @file inigroups.inc
+ * @ingroup Examples
+ * @brief class IniGroups
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
if (!class_exists("KeyFilter")) require_once("keyfilter.inc");
if (!class_exists("DbaReader")) require_once("dbareader.inc");
-/** \ingroup Examples
+/** @ingroup Examples
* @brief Class to iterate all groups within an ini file.
* @author Marcus Boerger
* @version 1.1
<?php
-/** \ingroup Examples
+/** @file keyfilter.inc
+ * @ingroup Examples
+ * @brief class KeyFilter
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief Regular expression filter for string iterators
* @author Marcus Boerger
* @version 1.1
<?php
-/**
+/** @file norewinditerator.inc
+ * @ingroup Examples
+ * @brief class NoRewindIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief An Iterator that doesn't call rewind
* @author Marcus Boerger
* @version 1.0
<?php
-/**
+/** @file regexfindfile.inc
+ * @ingroup Examples
+ * @brief class RegexFindFile
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
+/** @ingroup Examples
* @brief Find files by regular expression
* @author Marcus Boerger
* @version 1.1
<?php
+/** @file searchiterator.inc
+ * @ingroup Examples
+ * @brief abstract class SearchIterator
+ * @author Marcus Boerger
+ * @date 2003 - 2004
+ *
+ * SPL - Standard PHP Library
+ */
+
/** @ingroup Examples
* @brief Iterator to search for a specific element
* @author Marcus Boerger
<?php
-/** tree view example
+/** @file tree.php
+ * @brief Program Tree view example
+ * @ingroup Examples
+ * @author Marcus Boerger
+ * @date 2003 - 2004
*
- * Usage: php tree.php <path>
+ * Usage: php tree.php \<path\>
*
- * Simply specify the path to tree with parameter <path>.
- *
- * (c) Marcus Boerger, 2003 - 2004
+ * Simply specify the path to tree with parameter \<path\>.
*/
// The following line only operates on classes which are converted to c already.
<?php
+/** \file spl.php
+ * \ingroup SPL
+ * \brief Documentation of internal classes and interfaces
+ *
+ * SPL - Standard PHP Library
+ *
+ * (c) Marcus Boerger, 2003 - 2004
+ */
+
/** \mainpage SPL - Standard PHP Library
*
* SPL - Standard PHP Library
projects / php / commitdiff