From: Marcus Boerger Date: Mon, 10 May 2004 17:26:03 +0000 (+0000) Subject: - Documentation update X-Git-Tag: RELEASE_0_1~237 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=68c22fba723c77c7a8ea6b2d33f580aa26bf88d8;p=php - Documentation update - Checkin doxygen config file # A patched version of doxygen is needed, hopefully 1.3.8 will contain it --- diff --git a/ext/spl/doxygen.cfg b/ext/spl/doxygen.cfg new file mode 100755 index 0000000000..6f8eda9bd1 --- /dev/null +++ b/ext/spl/doxygen.cfg @@ -0,0 +1,209 @@ +# 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 diff --git a/ext/spl/examples/appenditerator.inc b/ext/spl/examples/appenditerator.inc index edc80410df..d2d5c8dd0b 100755 --- a/ext/spl/examples/appenditerator.inc +++ b/ext/spl/examples/appenditerator.inc @@ -1,6 +1,15 @@ [] + * Usage php dba_array.php \ \ \ [\] * - * If is specified then is set to in . - * Else the value of is printed only. + * If \ is specified then \ is set to \ in \. + * Else the value of \ is printed only. * * Note: configure with --enable-dba - * - * (c) Marcus Boerger, 2003 - 2004 */ if ($argc < 4) { diff --git a/ext/spl/examples/dba_dump.php b/ext/spl/examples/dba_dump.php index 613674fef8..7121babac6 100755 --- a/ext/spl/examples/dba_dump.php +++ b/ext/spl/examples/dba_dump.php @@ -1,15 +1,17 @@ [] + * Usage: php dba_dump.php \ \ [\] * - * Show all groups in the ini file specified by . - * The regular expression is used to filter the by setting name. + * Show all groups in the ini file specified by \. + * The regular expression \ is used to filter the by setting name. * * Note: configure with --enable-dba - * - * (c) Marcus Boerger, 2003 - 2004 */ if ($argc < 3) { diff --git a/ext/spl/examples/dbaarray.inc b/ext/spl/examples/dbaarray.inc index 51cd38fadf..1064b581e8 100755 --- a/ext/spl/examples/dbaarray.inc +++ b/ext/spl/examples/dbaarray.inc @@ -1,8 +1,17 @@ [ []] + * Usage: php directorytree.php \ [\ [\]] * - * Simply specify the path to tree with parameter . - * - * (c) Marcus Boerger, 2003 + * Simply specify the path to tree with parameter \. */ if ($argc < 2) { @@ -26,6 +24,8 @@ EOF; exit(1); } +if (!class_exists("DirectoryTreeIterator")) require_once("directorytreeiterator.inc"); + $length = $argc > 3 ? $argv[3] : -1; echo $argv[1]."\n"; diff --git a/ext/spl/examples/directorytreeiterator.inc b/ext/spl/examples/directorytreeiterator.inc index 4fadd6f71b..38bf240e70 100644 --- a/ext/spl/examples/directorytreeiterator.inc +++ b/ext/spl/examples/directorytreeiterator.inc @@ -1,6 +1,15 @@ + * Usage: php findfile.php \ \ * - * Path to search in. You can specify multiple paths by separating + * \ Path to search in. You can specify multiple paths by separating * them with ';'. - * Filename to look for. - * - * (c) Marcus Boerger, 2003 - 2004 + * \ Filename to look for. */ if ($argc < 3) { @@ -25,5 +27,7 @@ EOF; 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 diff --git a/ext/spl/examples/findregex.php b/ext/spl/examples/findregex.php index 55431c0e38..8a7dd8158d 100755 --- a/ext/spl/examples/findregex.php +++ b/ext/spl/examples/findregex.php @@ -1,13 +1,15 @@ + * Usage: php findregex.php \ \ * - * Path to search in. - * Filename to look for. - * - * (c) Marcus Boerger, Adam Trachtenberg, 2004 + * \ Path to search in. + * \ Filename to look for. */ if ($argc < 3) { diff --git a/ext/spl/examples/infiniteiterator.inc b/ext/spl/examples/infiniteiterator.inc index 9a3a2eca89..5f27633eb3 100755 --- a/ext/spl/examples/infiniteiterator.inc +++ b/ext/spl/examples/infiniteiterator.inc @@ -1,6 +1,15 @@ [] + * Usage: php dba_dump.php \ [\] * - * Show all groups in the ini file specified by . - * The regular expression is used to filter the result. + * Show all groups in the ini file specified by \. + * The regular expression \ is used to filter the result. * * Note: configure with --enable-dba - * - * (c) Marcus Boerger, 2003 - 2004 */ if ($argc < 2) { diff --git a/ext/spl/examples/inigroups.inc b/ext/spl/examples/inigroups.inc index 745930643b..519c31631a 100755 --- a/ext/spl/examples/inigroups.inc +++ b/ext/spl/examples/inigroups.inc @@ -1,9 +1,18 @@ + * Usage: php tree.php \ * - * Simply specify the path to tree with parameter . - * - * (c) Marcus Boerger, 2003 - 2004 + * Simply specify the path to tree with parameter \. */ // The following line only operates on classes which are converted to c already. diff --git a/ext/spl/spl.php b/ext/spl/spl.php index 55de408d3f..5c77857ff9 100755 --- a/ext/spl/spl.php +++ b/ext/spl/spl.php @@ -1,5 +1,14 @@