From fbeba502ffbf868bb8bffe46cc3ec15acc5d4194 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Sun, 13 Mar 2011 19:28:25 +0400 Subject: [PATCH 01/26] initial idea was to add rendering for gd image to show a thumbnail to picture it was not realized but some code was kept to remember about it --- dBug.php | 2 ++ 1 file changed, 2 insertions(+) diff --git a/dBug.php b/dBug.php index bc109b7..ba7c569 100755 --- a/dBug.php +++ b/dBug.php @@ -327,6 +327,8 @@ function varIsGDResource($var) { echo imagesy($var).$this->closeTDRow(); $this->makeTDHeader("resource","Colors"); echo imagecolorstotal($var).$this->closeTDRow(); + /*$this->makeTDHeader("resource","Image"); + echo '"; } From d6764a4da456558c81391c44ce75eda16e118ab7 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Fri, 6 Jan 2012 11:42:22 +0400 Subject: [PATCH 02/26] Null improved --- dBug.php | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/dBug.php b/dBug.php index ba7c569..547c364 100755 --- a/dBug.php +++ b/dBug.php @@ -169,7 +169,9 @@ function checkType($var) { //if variable is a NULL type function varIsNULL() { + $this->makeTableHeader("false","NULL"); echo "NULL"; + echo ""; } //if variable is a boolean type @@ -488,7 +490,8 @@ function dBug_toggleTable(source) { .dBug_objectHeader, .dBug_resourceHeader, .dBug_resourceCHeader, - .dBug_xmlHeader + .dBug_xmlHeader, + .dBug_falseHeader { font-weight:bold; color:#FFFFFF; cursor:pointer; } .dBug_arrayKey, @@ -525,6 +528,11 @@ function dBug_toggleTable(source) { table.dBug_xml td { background-color:#FFFFFF; } table.dBug_xml td.dBug_xmlHeader { background-color:#AAAAAA; } table.dBug_xml td.dBug_xmlKey { background-color:#DDDDDD; } + /* FALSE */ + table.dBug_false { background-color:#CB0101; } + table.dBug_false td { background-color:#FFFFFF; } + table.dBug_false td.dBug_falseHeader { background-color:#F2054C; } + table.dBug_false td.dBug_falseKey { background-color:#DDDDDD; } SCRIPTS; } From 59636bbaa7cfe1029ff2d5aad749b772d776ab79 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Fri, 6 Jan 2012 12:02:45 +0400 Subject: [PATCH 03/26] Numeric improvement --- dBug.php | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/dBug.php b/dBug.php index 547c364..f16974e 100755 --- a/dBug.php +++ b/dBug.php @@ -144,7 +144,8 @@ function error($type) { //check variable type function checkType($var) { - switch(gettype($var)) { + $type=gettype($var); + switch($type) { case "resource": $this->varIsResource($var); break; @@ -154,6 +155,10 @@ function checkType($var) { case "array": $this->varIsArray($var); break; + case "integer": + case "double": + $this->varIsNumeric($var,$type); + break; case "NULL": $this->varIsNULL(); break; @@ -174,6 +179,12 @@ function varIsNULL() { echo ""; } + //if variable is a numeric type + function varIsNumeric($var,$type) { + $this->makeTableHeader("numeric",$type."(".$var.")"); + echo ""; + } + //if variable is a boolean type function varIsBoolean($var) { $var=($var==1) ? "TRUE" : "FALSE"; @@ -491,7 +502,8 @@ function dBug_toggleTable(source) { .dBug_resourceHeader, .dBug_resourceCHeader, .dBug_xmlHeader, - .dBug_falseHeader + .dBug_falseHeader, + .dBug_numericHeader { font-weight:bold; color:#FFFFFF; cursor:pointer; } .dBug_arrayKey, @@ -533,6 +545,11 @@ function dBug_toggleTable(source) { table.dBug_false td { background-color:#FFFFFF; } table.dBug_false td.dBug_falseHeader { background-color:#F2054C; } table.dBug_false td.dBug_falseKey { background-color:#DDDDDD; } + /* numeric */ + table.dBug_numeric { background-color:#F9C007; } + table.dBug_numeric td { background-color:#FFFFFF; } + table.dBug_numeric td.dBug_numericHeader { background-color:#F2D904; } + table.dBug_numeric td.dBug_numericKey { background-color:#DDDDDD; } SCRIPTS; } From c0dd938f7eef5355c62d2b2bcc06727b61cf8ec8 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Fri, 6 Jan 2012 19:15:21 +0400 Subject: [PATCH 04/26] Added support sqlite3 class --- dBug.php | 66 ++++++++++++++++++++++++++++++++++++++++++++++++++++---- 1 file changed, 62 insertions(+), 4 deletions(-) diff --git a/dBug.php b/dBug.php index f16974e..18d78b8 100755 --- a/dBug.php +++ b/dBug.php @@ -175,7 +175,7 @@ function checkType($var) { //if variable is a NULL type function varIsNULL() { $this->makeTableHeader("false","NULL"); - echo "NULL"; + //echo "NULL"; echo ""; } @@ -224,6 +224,8 @@ function varIsArray($var) { //if variable is an object type function varIsObject($var) { + if($this->varIsDBObject($var))return 1; + $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); $this->makeTableHeader("object","object"); @@ -286,7 +288,57 @@ function varIsResource($var) { } echo $this->closeTDRow()."\n"; } - + + function varIsDBObject($var) { + if($var instanceof SQLite3Result){ + //$var=clone $var; + $structure=array(); + $data=array(); + $dbtype=""; + $count=$var->numColumns(); + for($i=0;$i<$count;$i++){ + $structure[$i]=array(); + $structure[$i][0]=$var->columnName($i); + $structure[$i][1]=$var->columnType($i); + } + $var->reset(); + while($res=$var->fetchArray(SQLITE3_NUM)){ + $data[]=$res; + } + $var->reset(); + $dbtype="SQLite3"; + unset($var); + $this->renderDBData($dbtype,$structure,$data); + unset($data); + unset($structure); + unset($dbtype); + + return 1; + } + return 0; + } + function renderDBData($db,&$structure,&$data){ + $this->makeTableHeader("database",$db." result",count($structure)+1); + echo " "; + foreach($structure as $field) { + echo ''.$field[0].""; + } + echo ""; + if(empty($data)){ + echo "[empty result]"; + }else + foreach($data as $row) { + echo "\n"; + echo "".($i+1).""; + for($k=0;$k".$fieldrow."\n"; + } + echo "\n"; + } + echo ""; + } + //if variable is a database resource type function varIsDBResource($var,$db="mysql") { if($db == "pgsql") @@ -503,7 +555,8 @@ function dBug_toggleTable(source) { .dBug_resourceCHeader, .dBug_xmlHeader, .dBug_falseHeader, - .dBug_numericHeader + .dBug_numericHeader, + .dBug_databaseHeader { font-weight:bold; color:#FFFFFF; cursor:pointer; } .dBug_arrayKey, @@ -549,7 +602,12 @@ function dBug_toggleTable(source) { table.dBug_numeric { background-color:#F9C007; } table.dBug_numeric td { background-color:#FFFFFF; } table.dBug_numeric td.dBug_numericHeader { background-color:#F2D904; } - table.dBug_numeric td.dBug_numericKey { background-color:#DDDDDD; } + /*table.dBug_numeric td.dBug_numericKey { background-color:#DDDDDD; }*/ + /* database */ + table.dBug_database { background-color:#8FB6E6 } + table.dBug_database td { background-color:#07DDF9; } + table.dBug_database td.dBug_databaseHeader { background-color:#07F7FB; } + table.dBug_database td.dBug_databaseKey { background-color:#AEF4F5; } SCRIPTS; } From ddfe8e2083ee30423b11475e2786019e26b221ca Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Fri, 6 Jan 2012 21:14:35 +0400 Subject: [PATCH 05/26] Added PDO --- dBug.php | 45 +++++++++++++++++++++++++++++++-------------- 1 file changed, 31 insertions(+), 14 deletions(-) diff --git a/dBug.php b/dBug.php index 18d78b8..1dbbbf8 100755 --- a/dBug.php +++ b/dBug.php @@ -290,10 +290,11 @@ function varIsResource($var) { } function varIsDBObject($var) { + $structure=array(); + $data=array(); + $retres=false; if($var instanceof SQLite3Result){ //$var=clone $var; - $structure=array(); - $data=array(); $dbtype=""; $count=$var->numColumns(); for($i=0;$i<$count;$i++){ @@ -309,16 +310,32 @@ function varIsDBObject($var) { $dbtype="SQLite3"; unset($var); $this->renderDBData($dbtype,$structure,$data); - unset($data); - unset($structure); - unset($dbtype); - - return 1; + $retres=true; } - return 0; + if($var instanceof PDOStatement){ + //$var=clone $var; + $count=$var->columnCount(); + $col=null; + for($i=0;$i<$count;$i++){ + $col=$var->getColumnMeta(0); + $structure[$i]=array(); + $structure[$i][0]=$col["name"]; + $structure[$i][1]=(isset($col["driver:decl_type"])?(isset($col["len"])?"({$col["len"]})":"")."\n":"")."({$col["native_type"]})"; + } + unset($col); + $data=$var->fetchAll(); + $dbtype="PDOStatement"; + unset($var); + $this->renderDBData($dbtype,$structure,$data); + $retres=true; + } + unset($dbtype); + unset($data); + unset($structure); + return $retres; } - function renderDBData($db,&$structure,&$data){ - $this->makeTableHeader("database",$db." result",count($structure)+1); + function renderDBData($objectType,&$structure,&$data){ + $this->makeTableHeader("database",$objectType,count($structure)+1); echo " "; foreach($structure as $field) { echo ''.$field[0].""; @@ -348,8 +365,8 @@ function varIsDBResource($var,$db="mysql") { $arrFields = array("name","type","flags"); $numrows=call_user_func($db."_num_rows",$var); $numfields=call_user_func($db."_num_fields",$var); - $this->makeTableHeader("resource",$db." result",$numfields+1); - echo " "; + $this->makeTableHeader("database",$db." result",$numfields+1); + echo " "; for($i=0;$i<$numfields;$i++) { $field_header = ""; for($j=0; $j".$field_name.""; + echo "".$field_name.""; } echo ""; for($i=0;$i<$numrows;$i++) { $row=call_user_func($db."_fetch_array",$var,constant(strtoupper($db)."_ASSOC")); echo "\n"; - echo "".($i+1).""; + echo "".($i+1).""; for($k=0;$k<$numfields;$k++) { $tempField=$field[$k]->name; $fieldrow=$row[($field[$k]->name)]; From fc5dd64b674fe8ded9df1130783de5a9e2483672 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Tue, 28 Feb 2012 17:06:59 +0400 Subject: [PATCH 06/26] String processing added --- dBug.php | 39 ++++++++++++++++++++++++++++++++------- 1 file changed, 32 insertions(+), 7 deletions(-) diff --git a/dBug.php b/dBug.php index 1dbbbf8..0977c5f 100755 --- a/dBug.php +++ b/dBug.php @@ -148,27 +148,30 @@ function checkType($var) { switch($type) { case "resource": $this->varIsResource($var); - break; + break; case "object": $this->varIsObject($var); - break; + break; case "array": $this->varIsArray($var); - break; + break; case "integer": case "double": $this->varIsNumeric($var,$type); - break; + break; case "NULL": $this->varIsNULL(); - break; + break; case "boolean": $this->varIsBoolean($var); - break; + break; + case "string": + $this->varIsString($var); + break; default: $var=($var=="") ? "[empty string]" : $var; echo "\n\n\n
".$var."
\n"; - break; + break; } } @@ -185,6 +188,23 @@ function varIsNumeric($var,$type) { echo ""; } + //if variable is a string type + function varIsString($var){ + if($var==""){ + $this->makeTableHeader("string","empty string"); + echo ""; + return; + } + $this->makeTableHeader("string","string (".strlen($var).")"); + $lines=explode("\n",$var); + foreach($lines as $num=>$line){ + $this->makeTDHeader("string",$num); + echo ($line==""?"[empty line]":$line); + $this->closeTDRow("string"); + } + echo ""; + } + //if variable is a boolean type function varIsBoolean($var) { $var=($var==1) ? "TRUE" : "FALSE"; @@ -625,6 +645,11 @@ function dBug_toggleTable(source) { table.dBug_database td { background-color:#07DDF9; } table.dBug_database td.dBug_databaseHeader { background-color:#07F7FB; } table.dBug_database td.dBug_databaseKey { background-color:#AEF4F5; } + /* string */ + table.dBug_string { background-color:#556832 } + table.dBug_string td { background-color:#B3C520;} + table.dBug_string td.dBug_stringHeader { background-color:#808000; } + table.dBug_string td.dBug_stringKey { background-color:#96A428; } SCRIPTS; } From 851b796cce1193d6b11bfc99a7ff175f8505716e Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Tue, 10 Jul 2012 11:15:52 +0400 Subject: [PATCH 07/26] added curl easy handle some methods get target variable by references now (need testing) --- dBug.php | 79 ++++++++++++++++++++++++++++++-------------------------- 1 file changed, 42 insertions(+), 37 deletions(-) diff --git a/dBug.php b/dBug.php index 0977c5f..b1821c8 100755 --- a/dBug.php +++ b/dBug.php @@ -1,30 +1,5 @@ makeTableHeader("string","empty string"); echo ""; return; } $this->makeTableHeader("string","string (".strlen($var).")"); - $lines=explode("\n",$var); + $nv=htmlspecialchars($var); + $lines=explode("\n",$nv); foreach($lines as $num=>$line){ $this->makeTDHeader("string",$num); echo ($line==""?"[empty line]":$line); @@ -206,13 +182,13 @@ function varIsString($var){ } //if variable is a boolean type - function varIsBoolean($var) { + function varIsBoolean(&$var) { $var=($var==1) ? "TRUE" : "FALSE"; echo $var; } //if variable is an array type - function varIsArray($var) { + function varIsArray(&$var) { $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); @@ -243,7 +219,7 @@ function varIsArray($var) { } //if variable is an object type - function varIsObject($var) { + function varIsObject(&$var) { if($this->varIsDBObject($var))return 1; $var_ser = serialize($var); @@ -285,7 +261,8 @@ function varIsObject($var) { function varIsResource($var) { $this->makeTableHeader("resourceC","resource",1); echo "\n\n"; - switch(get_resource_type($var)) { + $restype=get_resource_type($var); + switch($restype) { case "fbsql result": case "mssql result": case "msql query": @@ -293,17 +270,23 @@ function varIsResource($var) { case "sybase-db result": case "sybase-ct result": case "mysql result": - $db=current(explode(" ",get_resource_type($var))); + $db=current(explode(" ",$restype)); $this->varIsDBResource($var,$db); - break; + break; case "gd": $this->varIsGDResource($var); - break; + break; case "xml": $this->varIsXmlResource($var); - break; + break; + case "curl": + $this->varIsCurlEasyResource($var); + break; + /*case "curl_multi": + $this->varIsCurlMultiResource($var); + break;*/ default: - echo get_resource_type($var).$this->closeTDRow(); + echo $restype.$this->closeTDRow(); break; } echo $this->closeTDRow()."\n"; @@ -430,7 +413,12 @@ function varIsGDResource($var) { $this->makeTDHeader("resource","Colors"); echo imagecolorstotal($var).$this->closeTDRow(); /*$this->makeTDHeader("resource","Image"); - echo ''.$this->closeTDRow();*/ echo ""; } @@ -472,6 +460,23 @@ function varIsXmlResource($var) { } + function varIsCurlEasyResource(&$var) { + $this->makeTableHeader("resource","curl easy handle",2); + $info=curl_getinfo($var); + foreach($info as $name=>&$piece){ + if($piece){ + $this->makeTDHeader("resource",$name); + echo $piece.$this->closeTDRow(); + } + } + unset($info); + echo ""; + + } + function varIsCurlMultiResource(&$var) { + + } + //parse xml function xmlParse($xml_parser,$data,$bFinal) { if (!xml_parse($xml_parser,$data,$bFinal)) { From bb46a39cefbd78892d4313013916be6c859e3730 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Tue, 10 Jul 2012 11:24:59 +0400 Subject: [PATCH 08/26] added some tests --- tests.php | 39 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 39 insertions(+) create mode 100644 tests.php diff --git a/tests.php b/tests.php new file mode 100644 index 0000000..dc5dedc --- /dev/null +++ b/tests.php @@ -0,0 +1,39 @@ +"1", + "second", + "third"=>array( + "inner third 1", + "inner third 2"=>"yeah"), + "fourth"); + new dBug($variable); + class Vegetable { + + var $edible; + var $color; + + function Vegetable($edible, $color="green") { + $this->edible = $edible; + $this->color = $color; + } + + function is_edible() { + return $this->edible; + } + + function what_color() { + return $this->color; + } + } + new dBug(new Vegetable("spinach")); + $a=curl_init("http://github.com/"); + new dBug($a); +?> \ No newline at end of file From 4948b40ef58a5b75862ce2a7462e4bceef9b2dc3 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Thu, 16 Aug 2012 19:02:47 +0400 Subject: [PATCH 09/26] added a box for bollean --- dBug.php | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/dBug.php b/dBug.php index b1821c8..8413a7e 100755 --- a/dBug.php +++ b/dBug.php @@ -183,8 +183,9 @@ function varIsString(&$var){ //if variable is a boolean type function varIsBoolean(&$var) { - $var=($var==1) ? "TRUE" : "FALSE"; + $var?$this->makeTableHeader("numeric","boolean (TRUE)"):$this->makeTableHeader("false","boolean (FALSE)"); echo $var; + echo ""; } //if variable is an array type @@ -320,13 +321,15 @@ function varIsDBObject($var) { $count=$var->columnCount(); $col=null; for($i=0;$i<$count;$i++){ - $col=$var->getColumnMeta(0); + //$col=$var->getColumnMeta(0); + $col=$var->getColumnMeta($i); $structure[$i]=array(); $structure[$i][0]=$col["name"]; $structure[$i][1]=(isset($col["driver:decl_type"])?(isset($col["len"])?"({$col["len"]})":"")."\n":"")."({$col["native_type"]})"; } unset($col); $data=$var->fetchAll(); + $var->closeCursor(); $dbtype="PDOStatement"; unset($var); $this->renderDBData($dbtype,$structure,$data); @@ -337,7 +340,7 @@ function varIsDBObject($var) { unset($structure); return $retres; } - function renderDBData($objectType,&$structure,&$data){ + function renderDBData(&$objectType,&$structure,&$data){ $this->makeTableHeader("database",$objectType,count($structure)+1); echo " "; foreach($structure as $field) { @@ -347,9 +350,10 @@ function renderDBData($objectType,&$structure,&$data){ if(empty($data)){ echo "[empty result]"; }else + $i=0; foreach($data as $row) { echo "\n"; - echo "".($i+1).""; + echo "".(++$i).""; for($k=0;$k".$fieldrow."\n"; From be6014ee4b6dd81d0046c8123d81bed6c5d01760 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Fri, 30 Nov 2012 01:07:27 +0400 Subject: [PATCH 10/26] strings, booleans and integers rendering improved some fixes in objects, arrays and resources rendering tests updated some docs added added doxyfile --- dBug.doxyfile | 1803 +++++++++++++++++++++++++++++++++++++++++++++++++ dBug.php | 477 ++++++++----- tests.php | 15 +- 3 files changed, 2119 insertions(+), 176 deletions(-) create mode 100644 dBug.doxyfile diff --git a/dBug.doxyfile b/dBug.doxyfile new file mode 100644 index 0000000..dc4e7e9 --- /dev/null +++ b/dBug.doxyfile @@ -0,0 +1,1803 @@ +# Doxyfile 1.8.2 + +# This file describes the settings to be used by the documentation system +# doxygen (www.doxygen.org) for a project +# +# All text after a hash (#) is considered a comment and will be ignored +# The format is: +# TAG = value [value, ...] +# For lists items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (" ") + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- + +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all +# text before the first occurrence of this tag. Doxygen uses libiconv (or the +# iconv built into libc) for the transcoding. See +# http://www.gnu.org/software/libiconv for the list of possible encodings. + +DOXYFILE_ENCODING = UTF-8 + +# The PROJECT_NAME tag is a single word (or sequence of words) that should +# identify the project. Note that if you do not use Doxywizard you need +# to put quotes around the project name if it contains spaces. + +PROJECT_NAME = dBug + +# The PROJECT_NUMBER tag can be used to enter a project or revision number. +# This could be handy for archiving the generated documentation or +# if some version control system is used. + +PROJECT_NUMBER = + +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer +# a quick idea about the purpose of the project. Keep the description short. + +PROJECT_BRIEF = "PHP debug output library" + +# With the PROJECT_LOGO tag one can specify an logo or icon that is +# included in the documentation. The maximum height of the logo should not +# exceed 55 pixels and the maximum width should not exceed 200 pixels. +# Doxygen will copy the logo to the output directory. + +PROJECT_LOGO = + +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) +# base path where the generated documentation will be put. +# If a relative path is entered, it will be relative to the location +# where doxygen was started. If left blank the current directory will be used. + +OUTPUT_DIRECTORY = E:\public_html\modules\dBug\doxygen + +# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create +# 4096 sub-directories (in 2 levels) under the output directory of each output +# format and will distribute the generated files over these directories. +# Enabling this option can be useful when feeding doxygen a huge amount of +# source files, where putting all generated files in the same directory would +# otherwise cause performance problems for the file system. + +CREATE_SUBDIRS = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# The default language is English, other supported languages are: +# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, +# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, +# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English +# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, +# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, +# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. + +OUTPUT_LANGUAGE = English + +# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will +# include brief member descriptions after the members that are listed in +# the file and class documentation (similar to JavaDoc). +# Set to NO to disable this. + +BRIEF_MEMBER_DESC = YES + +# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend +# the brief description of a member or function before the detailed description. +# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# brief descriptions will be completely suppressed. + +REPEAT_BRIEF = YES + +# This tag implements a quasi-intelligent brief description abbreviator +# that is used to form the text in various listings. Each string +# in this list, if found as the leading text of the brief description, will be +# stripped from the text and the result after processing the whole list, is +# used as the annotated text. Otherwise, the brief description is used as-is. +# If left blank, the following values are used ("$name" is automatically +# replaced with the name of the entity): "The $name class" "The $name widget" +# "The $name file" "is" "provides" "specifies" "contains" +# "represents" "a" "an" "the" + +ABBREVIATE_BRIEF = + +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# Doxygen will generate a detailed section even if there is only a brief +# description. + +ALWAYS_DETAILED_SEC = NO + +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment +# operators of the base classes will not be shown. + +INLINE_INHERITED_MEMB = NO + +# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full +# path before files name in the file list and in the header files. If set +# to NO the shortest path that makes the file name unique will be used. + +FULL_PATH_NAMES = YES + +# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag +# can be used to strip a user-defined part of the path. Stripping is +# only done if one of the specified strings matches the left-hand part of +# the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the +# path to strip. Note that you specify absolute paths here, but also +# relative paths, which will be relative from the directory where doxygen is +# started. + +STRIP_FROM_PATH = E:\public_html\modules\dBug + +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of +# the path mentioned in the documentation of a class, which tells +# the reader which header file to include in order to use a class. +# If left blank only the name of the header file containing the class +# definition is used. Otherwise one should specify the include paths that +# are normally passed to the compiler using the -I flag. + +STRIP_FROM_INC_PATH = + +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter +# (but less readable) file names. This can be useful if your file system +# doesn't support long names like on DOS, Mac, or CD-ROM. + +SHORT_NAMES = YES + +# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen +# will interpret the first line (until the first dot) of a JavaDoc-style +# comment as the brief description. If set to NO, the JavaDoc +# comments will behave just like regular Qt-style comments +# (thus requiring an explicit @brief command for a brief description.) + +JAVADOC_AUTOBRIEF = YES + +# If the QT_AUTOBRIEF tag is set to YES then Doxygen will +# interpret the first line (until the first dot) of a Qt-style +# comment as the brief description. If set to NO, the comments +# will behave just like regular Qt-style comments (thus requiring +# an explicit \brief command for a brief description.) + +QT_AUTOBRIEF = YES + +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen +# treat a multi-line C++ special comment block (i.e. a block of //! or /// +# comments) as a brief description. This used to be the default behaviour. +# The new default is to treat a multi-line C++ comment block as a detailed +# description. Set this tag to YES if you prefer the old behaviour instead. + +MULTILINE_CPP_IS_BRIEF = NO + +# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented +# member inherits the documentation from any documented member that it +# re-implements. + +INHERIT_DOCS = YES + +# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce +# a new page for each member. If set to NO, the documentation of a member will +# be part of the file/class/namespace that contains it. + +SEPARATE_MEMBER_PAGES = NO + +# The TAB_SIZE tag can be used to set the number of spaces in a tab. +# Doxygen uses this value to replace tabs by spaces in code fragments. + +TAB_SIZE = 4 + +# This tag can be used to specify a number of aliases that acts +# as commands in the documentation. An alias has the form "name=value". +# For example adding "sideeffect=\par Side Effects:\n" will allow you to +# put the command \sideeffect (or @sideeffect) in the documentation, which +# will result in a user-defined paragraph with heading "Side Effects:". +# You can put \n's in the value part of an alias to insert newlines. + +ALIASES = + +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding +# "class=itcl::class" will allow you to use the command class in the +# itcl::class meaning. + +TCL_SUBST = + +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C +# sources only. Doxygen will then generate output that is more tailored for C. +# For instance, some of the names that are used will be different. The list +# of all members will be omitted, etc. + +OPTIMIZE_OUTPUT_FOR_C = YES + +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java +# sources only. Doxygen will then generate output that is more tailored for +# Java. For instance, namespaces will be presented as packages, qualified +# scopes will look different, etc. + +OPTIMIZE_OUTPUT_JAVA = NO + +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources only. Doxygen will then generate output that is more tailored for +# Fortran. + +OPTIMIZE_FOR_FORTRAN = NO + +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for +# VHDL. + +OPTIMIZE_OUTPUT_VHDL = NO + +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, +# and language is one of the parsers supported by doxygen: IDL, Java, +# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, +# C++. For instance to make doxygen treat .inc files as Fortran files (default +# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note +# that for custom extensions you also need to set FILE_PATTERNS otherwise the +# files are not read by doxygen. + +EXTENSION_MAPPING = + +# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all +# comments according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you +# can mix doxygen, HTML, and XML commands with Markdown formatting. +# Disable only in case of backward compatibilities issues. + +MARKDOWN_SUPPORT = YES + +# When enabled doxygen tries to link words that correspond to documented classes, +# or namespaces to their corresponding documentation. Such a link can be +# prevented in individual cases by by putting a % sign in front of the word or +# globally by setting AUTOLINK_SUPPORT to NO. + +AUTOLINK_SUPPORT = YES + +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should +# set this tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. +# func(std::string) {}). This also makes the inheritance and collaboration +# diagrams that involve STL classes more complete and accurate. + +BUILTIN_STL_SUPPORT = YES + +# If you use Microsoft's C++/CLI language, you should set this option to YES to +# enable parsing support. + +CPP_CLI_SUPPORT = NO + +# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. +# Doxygen will parse them like normal C++ but will assume all classes use public +# instead of private inheritance when no explicit protection keyword is present. + +SIP_SUPPORT = NO + +# For Microsoft's IDL there are propget and propput attributes to indicate +# getter and setter methods for a property. Setting this option to YES (the +# default) will make doxygen replace the get and set methods by a property in +# the documentation. This will only work if the methods are indeed getting or +# setting a simple type. If this is not the case, or you want to show the +# methods anyway, you should set this option to NO. + +IDL_PROPERTY_SUPPORT = YES + +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES, then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default +# all members of a group must be documented explicitly. + +DISTRIBUTE_GROUP_DOC = NO + +# Set the SUBGROUPING tag to YES (the default) to allow class member groups of +# the same type (for instance a group of public functions) to be put as a +# subgroup of that type (e.g. under the Public Functions section). Set it to +# NO to prevent subgrouping. Alternatively, this can be done per class using +# the \nosubgrouping command. + +SUBGROUPING = YES + +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and +# unions are shown inside the group in which they are included (e.g. using +# @ingroup) instead of on a separate page (for HTML and Man pages) or +# section (for LaTeX and RTF). + +INLINE_GROUPED_CLASSES = NO + +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and +# unions with only public data fields will be shown inline in the documentation +# of the scope in which they are defined (i.e. file, namespace, or group +# documentation), provided this scope is documented. If set to NO (the default), +# structs, classes, and unions are shown on a separate page (for HTML and Man +# pages) or section (for LaTeX and RTF). + +INLINE_SIMPLE_STRUCTS = NO + +# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum +# is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically +# be useful for C code in case the coding convention dictates that all compound +# types are typedef'ed and only the typedef is referenced, never the tag name. + +TYPEDEF_HIDES_STRUCT = NO + +# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to +# determine which symbols to keep in memory and which to flush to disk. +# When the cache is full, less often used symbols will be written to disk. +# For small to medium size projects (<1000 input files) the default value is +# probably good enough. For larger projects a too small cache size can cause +# doxygen to be busy swapping symbols to and from disk most of the time +# causing a significant performance penalty. +# If the system has enough physical memory increasing the cache will improve the +# performance by keeping more symbols in memory. Note that the value works on +# a logarithmic scale so increasing the size by one will roughly double the +# memory usage. The cache size is given by this formula: +# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +SYMBOL_CACHE_SIZE = 0 + +# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be +# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given +# their name and scope. Since this can be an expensive process and often the +# same symbol appear multiple times in the code, doxygen keeps a cache of +# pre-resolved symbols. If the cache is too small doxygen will become slower. +# If the cache is too large, memory is wasted. The cache size is given by this +# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, +# corresponding to a cache size of 2^16 = 65536 symbols. + +LOOKUP_CACHE_SIZE = 0 + +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- + +# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in +# documentation are documented, even if no documentation was available. +# Private class members and static file members will be hidden unless +# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES + +EXTRACT_ALL = YES + +# If the EXTRACT_PRIVATE tag is set to YES all private members of a class +# will be included in the documentation. + +EXTRACT_PRIVATE = YES + +# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# scope will be included in the documentation. + +EXTRACT_PACKAGE = YES + +# If the EXTRACT_STATIC tag is set to YES all static members of a file +# will be included in the documentation. + +EXTRACT_STATIC = YES + +# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) +# defined locally in source files will be included in the documentation. +# If set to NO only classes defined in header files are included. + +EXTRACT_LOCAL_CLASSES = YES + +# This flag is only useful for Objective-C code. When set to YES local +# methods, which are defined in the implementation section but not in +# the interface are included in the documentation. +# If set to NO (the default) only methods in the interface are included. + +EXTRACT_LOCAL_METHODS = YES + +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base +# name of the file that contains the anonymous namespace. By default +# anonymous namespaces are hidden. + +EXTRACT_ANON_NSPACES = NO + +# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all +# undocumented members of documented classes, files or namespaces. +# If set to NO (the default) these members will be included in the +# various overviews, but no documentation section is generated. +# This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_MEMBERS = NO + +# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. +# If set to NO (the default) these classes will be included in the various +# overviews. This option has no effect if EXTRACT_ALL is enabled. + +HIDE_UNDOC_CLASSES = NO + +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all +# friend (class|struct|union) declarations. +# If set to NO (the default) these declarations will be included in the +# documentation. + +HIDE_FRIEND_COMPOUNDS = NO + +# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any +# documentation blocks found inside the body of a function. +# If set to NO (the default) these blocks will be appended to the +# function's detailed documentation block. + +HIDE_IN_BODY_DOCS = NO + +# The INTERNAL_DOCS tag determines if documentation +# that is typed after a \internal command is included. If the tag is set +# to NO (the default) then the documentation will be excluded. +# Set it to YES to include the internal documentation. + +INTERNAL_DOCS = YES + +# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate +# file names in lower-case letters. If set to YES upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows +# and Mac users are advised to set this option to NO. + +CASE_SENSE_NAMES = NO + +# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen +# will show members with their full class and namespace scopes in the +# documentation. If set to YES the scope will be hidden. + +HIDE_SCOPE_NAMES = YES + +# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen +# will put a list of the files that are included by a file in the documentation +# of that file. + +SHOW_INCLUDE_FILES = YES + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen +# will list include files with double quotes in the documentation +# rather than with sharp brackets. + +FORCE_LOCAL_INCLUDES = NO + +# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] +# is inserted in the documentation for inline members. + +INLINE_INFO = YES + +# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen +# will sort the (detailed) documentation of file and class members +# alphabetically by member name. If set to NO the members will appear in +# declaration order. + +SORT_MEMBER_DOCS = YES + +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the +# brief documentation of file, namespace and class members alphabetically +# by member name. If set to NO (the default) the members will appear in +# declaration order. + +SORT_BRIEF_DOCS = NO + +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen +# will sort the (brief and detailed) documentation of class members so that +# constructors and destructors are listed first. If set to NO (the default) +# the constructors will appear in the respective orders defined by +# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. +# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO +# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. + +SORT_MEMBERS_CTORS_1ST = YES + +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the +# hierarchy of group names into alphabetical order. If set to NO (the default) +# the group names will appear in their defined order. + +SORT_GROUP_NAMES = YES + +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be +# sorted by fully-qualified names, including namespaces. If set to +# NO (the default), the class list will be sorted only by class name, +# not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the +# alphabetical list. + +SORT_BY_SCOPE_NAME = NO + +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to +# do proper type resolution of all parameters of a function it will reject a +# match between the prototype and the implementation of a member function even +# if there is only one candidate or it is obvious which candidate to choose +# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen +# will still accept a match between prototype and implementation in such cases. + +STRICT_PROTO_MATCHING = NO + +# The GENERATE_TODOLIST tag can be used to enable (YES) or +# disable (NO) the todo list. This list is created by putting \todo +# commands in the documentation. + +GENERATE_TODOLIST = YES + +# The GENERATE_TESTLIST tag can be used to enable (YES) or +# disable (NO) the test list. This list is created by putting \test +# commands in the documentation. + +GENERATE_TESTLIST = YES + +# The GENERATE_BUGLIST tag can be used to enable (YES) or +# disable (NO) the bug list. This list is created by putting \bug +# commands in the documentation. + +GENERATE_BUGLIST = YES + +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or +# disable (NO) the deprecated list. This list is created by putting +# \deprecated commands in the documentation. + +GENERATE_DEPRECATEDLIST= YES + +# The ENABLED_SECTIONS tag can be used to enable conditional +# documentation sections, marked by \if sectionname ... \endif. + +ENABLED_SECTIONS = + +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines +# the initial value of a variable or macro consists of for it to appear in +# the documentation. If the initializer consists of more lines than specified +# here it will be hidden. Use a value of 0 to hide initializers completely. +# The appearance of the initializer of individual variables and macros in the +# documentation can be controlled using \showinitializer or \hideinitializer +# command in the documentation regardless of this setting. + +MAX_INITIALIZER_LINES = 30 + +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated +# at the bottom of the documentation of classes and structs. If set to YES the +# list will mention the files that were used to generate the documentation. + +SHOW_USED_FILES = YES + +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. +# This will remove the Files entry from the Quick Index and from the +# Folder Tree View (if specified). The default is YES. + +SHOW_FILES = YES + +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the +# Namespaces page. This will remove the Namespaces entry from the Quick Index +# and from the Folder Tree View (if specified). The default is YES. + +SHOW_NAMESPACES = YES + +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command , where is the value of +# the FILE_VERSION_FILTER tag, and is the name of an input file +# provided by doxygen. Whatever the program writes to standard output +# is used as the file version. See the manual for examples. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. +# You can optionally specify a file name after the option, if omitted +# DoxygenLayout.xml will be used as the name of the layout file. + +LAYOUT_FILE = + +# The CITE_BIB_FILES tag can be used to specify one or more bib files +# containing the references data. This must be a list of .bib files. The +# .bib extension is automatically appended if omitted. Using this command +# requires the bibtex tool to be installed. See also +# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style +# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this +# feature you need bibtex and perl available in the search path. + +CITE_BIB_FILES = + +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- + +# The QUIET tag can be used to turn on/off the messages that are generated +# by doxygen. Possible values are YES and NO. If left blank NO is used. + +QUIET = NO + +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated by doxygen. Possible values are YES and NO. If left blank +# NO is used. + +WARNINGS = YES + +# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings +# for undocumented members. If EXTRACT_ALL is set to YES then this flag will +# automatically be disabled. + +WARN_IF_UNDOCUMENTED = NO + +# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some +# parameters in a documented function, or documenting parameters that +# don't exist or using markup commands wrongly. + +WARN_IF_DOC_ERROR = YES + +# The WARN_NO_PARAMDOC option can be enabled to get warnings for +# functions that are documented, but have no documentation for their parameters +# or return value. If set to NO (the default) doxygen will only warn about +# wrong or incomplete parameter documentation, but not about the absence of +# documentation. + +WARN_NO_PARAMDOC = NO + +# The WARN_FORMAT tag determines the format of the warning messages that +# doxygen can produce. The string should contain the $file, $line, and $text +# tags, which will be replaced by the file and line number from which the +# warning originated and the warning text. Optionally the format may contain +# $version, which will be replaced by the version of the file (if it could +# be obtained via FILE_VERSION_FILTER) + +WARN_FORMAT = "$file:$line: $text" + +# The WARN_LOGFILE tag can be used to specify a file to which warning +# and error messages should be written. If left blank the output is written +# to stderr. + +WARN_LOGFILE = + +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- + +# The INPUT tag can be used to specify the files and/or directories that contain +# documented source files. You may enter file names like "myfile.cpp" or +# directories like "/usr/src/myproject". Separate the files or directories +# with spaces. + +INPUT = E:\public_html\modules\dBug\dBug.php + +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is +# also the default input encoding. Doxygen uses libiconv (or the iconv built +# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for +# the list of possible encodings. + +INPUT_ENCODING = UTF-8 + +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank the following patterns are tested: +# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh +# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py +# *.f90 *.f *.for *.vhd *.vhdl + +FILE_PATTERNS = *.php + +# The RECURSIVE tag can be used to turn specify whether or not subdirectories +# should be searched for input files as well. Possible values are YES and NO. +# If left blank NO is used. + +RECURSIVE = YES + +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# Note that relative paths are relative to the directory from which doxygen is +# run. + +EXCLUDE = + +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded +# from the input. + +EXCLUDE_SYMLINKS = NO + +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. Note that the wildcards are matched +# against the file with absolute path, so to exclude all test directories +# for example use the pattern */test/* + +EXCLUDE_PATTERNS = */.*/* + +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, +# AClass::ANamespace, ANamespace::*Test + +EXCLUDE_SYMBOLS = + +# The EXAMPLE_PATH tag can be used to specify one or more files or +# directories that contain example code fragments that are included (see +# the \include command). + +EXAMPLE_PATH = E:\public_html\modules\dBug\tests.php + +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp +# and *.h) to filter out the source-files in the directories. If left +# blank all files are included. + +EXAMPLE_PATTERNS = + +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude +# commands irrespective of the value of the RECURSIVE tag. +# Possible values are YES and NO. If left blank NO is used. + +EXAMPLE_RECURSIVE = YES + +# The IMAGE_PATH tag can be used to specify one or more files or +# directories that contain image that are included in the documentation (see +# the \image command). + +IMAGE_PATH = + +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command , where +# is the value of the INPUT_FILTER tag, and is the name of an +# input file. Doxygen will then use the output that the filter program writes +# to standard output. If FILTER_PATTERNS is specified, this tag will be +# ignored. + +INPUT_FILTER = + +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: +# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further +# info on how filters are used. If FILTER_PATTERNS is empty or if +# non of the patterns match the file name, INPUT_FILTER is applied. + +FILTER_PATTERNS = + +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will be used to filter the input files when producing source +# files to browse (i.e. when SOURCE_BROWSER is set to YES). + +FILTER_SOURCE_FILES = NO + +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) +# and it is also possible to disable source filtering for a specific pattern +# using *.ext= (so without naming a filter). This option only has effect when +# FILTER_SOURCE_FILES is enabled. + +FILTER_SOURCE_PATTERNS = + +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- + +# If the SOURCE_BROWSER tag is set to YES then a list of source files will +# be generated. Documented entities will be cross-referenced with these sources. +# Note: To get rid of all source code in the generated output, make sure also +# VERBATIM_HEADERS is set to NO. + +SOURCE_BROWSER = YES + +# Setting the INLINE_SOURCES tag to YES will include the body +# of functions and classes directly in the documentation. + +INLINE_SOURCES = NO + +# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct +# doxygen to hide any special comment blocks from generated source code +# fragments. Normal C, C++ and Fortran comments will always remain visible. + +STRIP_CODE_COMMENTS = YES + +# If the REFERENCED_BY_RELATION tag is set to YES +# then for each documented function all documented +# functions referencing it will be listed. + +REFERENCED_BY_RELATION = YES + +# If the REFERENCES_RELATION tag is set to YES +# then for each documented function all documented entities +# called/used by that function will be listed. + +REFERENCES_RELATION = YES + +# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) +# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from +# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will +# link to the source code. Otherwise they will link to the documentation. + +REFERENCES_LINK_SOURCE = YES + +# If the USE_HTAGS tag is set to YES then the references to source code +# will point to the HTML generated by the htags(1) tool instead of doxygen +# built-in source browser. The htags tool is part of GNU's global source +# tagging system (see http://www.gnu.org/software/global/global.html). You +# will need version 4.8.6 or higher. + +USE_HTAGS = NO + +# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen +# will generate a verbatim copy of the header file for each class for +# which an include is specified. Set to NO to disable this. + +VERBATIM_HEADERS = YES + +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- + +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index +# of all compounds will be generated. Enable this if the project +# contains a lot of classes, structs, unions or interfaces. + +ALPHABETICAL_INDEX = YES + +# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then +# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns +# in which this list will be split (can be a number in the range [1..20]) + +COLS_IN_ALPHA_INDEX = 5 + +# In case all classes in a project start with a common prefix, all +# classes will be put under the same header in the alphabetical index. +# The IGNORE_PREFIX tag can be used to specify one or more prefixes that +# should be ignored while generating the index headers. + +IGNORE_PREFIX = + +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- + +# If the GENERATE_HTML tag is set to YES (the default) Doxygen will +# generate HTML output. + +GENERATE_HTML = YES + +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `html' will be used as the default path. + +HTML_OUTPUT = html + +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for +# each generated HTML page (for example: .htm,.php,.asp). If it is left blank +# doxygen will generate files with .html extension. + +HTML_FILE_EXTENSION = .html + +# The HTML_HEADER tag can be used to specify a personal HTML header for +# each generated HTML page. If it is left blank doxygen will generate a +# standard header. Note that when using a custom header you are responsible +# for the proper inclusion of any scripts and style sheets that doxygen +# needs, which is dependent on the configuration options used. +# It is advised to generate a default header using "doxygen -w html +# header.html footer.html stylesheet.css YourConfigFile" and then modify +# that header. Note that the header is subject to change so you typically +# have to redo this when upgrading to a newer version of doxygen or when +# changing the value of configuration settings such as GENERATE_TREEVIEW! + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a personal HTML footer for +# each generated HTML page. If it is left blank doxygen will generate a +# standard footer. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading +# style sheet that is used by each HTML page. It can be used to +# fine-tune the look of the HTML output. If left blank doxygen will +# generate a default style sheet. Note that it is recommended to use +# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this +# tag will in the future become obsolete. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional +# user-defined cascading style sheet that is included after the standard +# style sheets created by doxygen. Using this option one can overrule +# certain style aspects. This is preferred over using HTML_STYLESHEET +# since it does not replace the standard style sheet and is therefor more +# robust against future updates. Doxygen will copy the style sheet file to +# the output directory. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that +# the files will be copied as-is; there are no commands or markers available. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. +# Doxygen will adjust the colors in the style sheet and background images +# according to this color. Hue is specified as an angle on a colorwheel, +# see http://en.wikipedia.org/wiki/Hue for more information. +# For instance the value 0 represents red, 60 is yellow, 120 is green, +# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. +# The allowed range is 0 to 359. + +HTML_COLORSTYLE_HUE = 220 + +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of +# the colors in the HTML output. For a value of 0 the output will use +# grayscales only. A value of 255 will produce the most vivid colors. + +HTML_COLORSTYLE_SAT = 100 + +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to +# the luminance component of the colors in the HTML output. Values below +# 100 gradually make the output lighter, whereas values above 100 make +# the output darker. The value divided by 100 is the actual gamma applied, +# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, +# and 100 does not change the gamma. + +HTML_COLORSTYLE_GAMMA = 80 + +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting +# this to NO can help when comparing the output of multiple runs. + +HTML_TIMESTAMP = YES + +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the +# page has loaded. + +HTML_DYNAMIC_SECTIONS = YES + +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of +# entries shown in the various tree structured indices initially; the user +# can expand and collapse entries dynamically later on. Doxygen will expand +# the tree to such a level that at most the specified number of entries are +# visible (unless a fully collapsed tree already exceeds this amount). +# So setting the number of entries 1 will produce a full collapsed tree by +# default. 0 is a special value representing an infinite number of entries +# and will result in a full expanded tree by default. + +HTML_INDEX_NUM_ENTRIES = 100 + +# If the GENERATE_DOCSET tag is set to YES, additional index files +# will be generated that can be used as input for Apple's Xcode 3 +# integrated development environment, introduced with OSX 10.5 (Leopard). +# To create a documentation set, doxygen will generate a Makefile in the +# HTML output directory. Running make will produce the docset in that +# directory and running "make install" will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find +# it at startup. +# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# for more information. + +GENERATE_DOCSET = NO + +# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the +# feed. A documentation feed provides an umbrella under which multiple +# documentation sets from a single provider (such as a company or product suite) +# can be grouped. + +DOCSET_FEEDNAME = "Doxygen generated docs" + +# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that +# should uniquely identify the documentation set bundle. This should be a +# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen +# will append .docset to the name. + +DOCSET_BUNDLE_ID = org.doxygen.Project + +# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely +# identify the documentation publisher. This should be a reverse domain-name +# style string, e.g. com.mycompany.MyDocSet.documentation. + +DOCSET_PUBLISHER_ID = org.doxygen.Publisher + +# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. + +DOCSET_PUBLISHER_NAME = Publisher + +# If the GENERATE_HTMLHELP tag is set to YES, additional index files +# will be generated that can be used as input for tools like the +# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) +# of the generated HTML documentation. + +GENERATE_HTMLHELP = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can +# be used to specify the file name of the resulting .chm file. You +# can add a path in front of the file if the result should not be +# written to the html output directory. + +CHM_FILE = + +# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can +# be used to specify the location (absolute path including file name) of +# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run +# the HTML help compiler on the generated index.hhp. + +HHC_LOCATION = + +# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag +# controls if a separate .chi index file is generated (YES) or that +# it should be included in the master .chm file (NO). + +GENERATE_CHI = NO + +# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING +# is used to encode HtmlHelp index (hhk), content (hhc) and project file +# content. + +CHM_INDEX_ENCODING = + +# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag +# controls whether a binary table of contents is generated (YES) or a +# normal table of contents (NO) in the .chm file. + +BINARY_TOC = NO + +# The TOC_EXPAND flag can be set to YES to add extra items for group members +# to the contents of the HTML help documentation and to the tree view. + +TOC_EXPAND = NO + +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated +# that can be used as input for Qt's qhelpgenerator to generate a +# Qt Compressed Help (.qch) of the generated HTML documentation. + +GENERATE_QHP = NO + +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can +# be used to specify the file name of the resulting .qch file. +# The path specified is relative to the HTML output folder. + +QCH_FILE = + +# The QHP_NAMESPACE tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#namespace + +QHP_NAMESPACE = org.doxygen.Project + +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating +# Qt Help Project output. For more information please see +# http://doc.trolltech.com/qthelpproject.html#virtual-folders + +QHP_VIRTUAL_FOLDER = doc + +# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to +# add. For more information please see +# http://doc.trolltech.com/qthelpproject.html#custom-filters + +QHP_CUST_FILTER_NAME = + +# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see +# +# Qt Help Project / Custom Filters. + +QHP_CUST_FILTER_ATTRS = + +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's +# filter section matches. +# +# Qt Help Project / Filter Attributes. + +QHP_SECT_FILTER_ATTRS = + +# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can +# be used to specify the location of Qt's qhelpgenerator. +# If non-empty doxygen will try to run qhelpgenerator on the generated +# .qhp file. + +QHG_LOCATION = + +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files +# will be generated, which together with the HTML files, form an Eclipse help +# plugin. To install this plugin and make it available under the help contents +# menu in Eclipse, the contents of the directory containing the HTML and XML +# files needs to be copied into the plugins directory of eclipse. The name of +# the directory within the plugins directory should be the same as +# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before +# the help appears. + +GENERATE_ECLIPSEHELP = NO + +# A unique identifier for the eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have +# this name. + +ECLIPSE_DOC_ID = org.doxygen.Project + +# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) +# at top of each HTML page. The value NO (the default) enables the index and +# the value YES disables it. Since the tabs have the same information as the +# navigation tree you can set this option to NO if you already set +# GENERATE_TREEVIEW to YES. + +DISABLE_INDEX = NO + +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. +# If the tag value is set to YES, a side panel will be generated +# containing a tree-like index structure (just like the one that +# is generated for HTML Help). For this to work a browser that supports +# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). +# Windows users are probably better off using the HTML help feature. +# Since the tree basically has the same information as the tab index you +# could consider to set DISABLE_INDEX to NO when enabling this option. + +GENERATE_TREEVIEW = YES + +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values +# (range [0,1..20]) that doxygen will group on one line in the generated HTML +# documentation. Note that a value of 0 will completely suppress the enum +# values from appearing in the overview section. + +ENUM_VALUES_PER_LINE = 1 + +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be +# used to set the initial width (in pixels) of the frame in which the tree +# is shown. + +TREEVIEW_WIDTH = 250 + +# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open +# links to external symbols imported via tag files in a separate window. + +EXT_LINKS_IN_WINDOW = NO + +# Use this tag to change the font size of Latex formulas included +# as images in the HTML documentation. The default is 10. Note that +# when you change the font size after a successful doxygen run you need +# to manually remove any form_*.png images from the HTML output directory +# to force them to be regenerated. + +FORMULA_FONTSIZE = 10 + +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are +# not supported properly for IE 6.0, but are supported on all modern browsers. +# Note that when changing this option you need to delete any form_*.png files +# in the HTML output before the changes have effect. + +FORMULA_TRANSPARENT = YES + +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax +# (see http://www.mathjax.org) which uses client side Javascript for the +# rendering instead of using prerendered bitmaps. Use this if you do not +# have LaTeX installed or if you want to formulas look prettier in the HTML +# output. When enabled you may also need to install MathJax separately and +# configure the path to it using the MATHJAX_RELPATH option. + +USE_MATHJAX = NO + +# When MathJax is enabled you need to specify the location relative to the +# HTML output directory using the MATHJAX_RELPATH option. The destination +# directory should contain the MathJax.js script. For instance, if the mathjax +# directory is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to +# the MathJax Content Delivery Network so you can quickly see the result without +# installing MathJax. However, it is strongly recommended to install a local +# copy of MathJax from http://www.mathjax.org before deployment. + +MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest + +# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension +# names that should be enabled during MathJax rendering. + +MATHJAX_EXTENSIONS = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box +# for the HTML output. The underlying search engine uses javascript +# and DHTML and should work on any modern browser. Note that when using +# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets +# (GENERATE_DOCSET) there is already a search function so this one should +# typically be disabled. For large projects the javascript based search engine +# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. + +SEARCHENGINE = YES + +# When the SERVER_BASED_SEARCH tag is enabled the search engine will be +# implemented using a PHP enabled web server instead of at the web client +# using Javascript. Doxygen will generate the search PHP script and index +# file to put on the web server. The advantage of the server +# based approach is that it scales better to large projects and allows +# full text search. The disadvantages are that it is more difficult to setup +# and does not have live searching capabilities. + +SERVER_BASED_SEARCH = NO + +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- + +# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will +# generate Latex output. + +GENERATE_LATEX = NO + +# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `latex' will be used as the default path. + +LATEX_OUTPUT = latex + +# The LATEX_CMD_NAME tag can be used to specify the LaTeX command name to be +# invoked. If left blank `latex' will be used as the default command name. +# Note that when enabling USE_PDFLATEX this option is only used for +# generating bitmaps for formulas in the HTML output, but not in the +# Makefile that is written to the output directory. + +LATEX_CMD_NAME = latex + +# The MAKEINDEX_CMD_NAME tag can be used to specify the command name to +# generate index for LaTeX. If left blank `makeindex' will be used as the +# default command name. + +MAKEINDEX_CMD_NAME = makeindex + +# If the COMPACT_LATEX tag is set to YES Doxygen generates more compact +# LaTeX documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_LATEX = NO + +# The PAPER_TYPE tag can be used to set the paper type that is used +# by the printer. Possible values are: a4, letter, legal and +# executive. If left blank a4wide will be used. + +PAPER_TYPE = a4 + +# The EXTRA_PACKAGES tag can be to specify one or more names of LaTeX +# packages that should be included in the LaTeX output. + +EXTRA_PACKAGES = + +# The LATEX_HEADER tag can be used to specify a personal LaTeX header for +# the generated latex document. The header should contain everything until +# the first chapter. If it is left blank doxygen will generate a +# standard header. Notice: only use this tag if you know what you are doing! + +LATEX_HEADER = + +# The LATEX_FOOTER tag can be used to specify a personal LaTeX footer for +# the generated latex document. The footer should contain everything after +# the last chapter. If it is left blank doxygen will generate a +# standard footer. Notice: only use this tag if you know what you are doing! + +LATEX_FOOTER = + +# If the PDF_HYPERLINKS tag is set to YES, the LaTeX that is generated +# is prepared for conversion to pdf (using ps2pdf). The pdf file will +# contain links (just like the HTML output) instead of page references +# This makes the output suitable for online browsing using a pdf viewer. + +PDF_HYPERLINKS = YES + +# If the USE_PDFLATEX tag is set to YES, pdflatex will be used instead of +# plain latex in the generated Makefile. Set this option to YES to get a +# higher quality PDF documentation. + +USE_PDFLATEX = YES + +# If the LATEX_BATCHMODE tag is set to YES, doxygen will add the \\batchmode. +# command to the generated LaTeX files. This will instruct LaTeX to keep +# running if errors occur, instead of asking the user for help. +# This option is also used when generating formulas in HTML. + +LATEX_BATCHMODE = NO + +# If LATEX_HIDE_INDICES is set to YES then doxygen will not +# include the index chapters (such as File Index, Compound Index, etc.) +# in the output. + +LATEX_HIDE_INDICES = NO + +# If LATEX_SOURCE_CODE is set to YES then doxygen will include +# source code with syntax highlighting in the LaTeX output. +# Note that which sources are shown also depends on other settings +# such as SOURCE_BROWSER. + +LATEX_SOURCE_CODE = YES + +# The LATEX_BIB_STYLE tag can be used to specify the style to use for the +# bibliography, e.g. plainnat, or ieeetr. The default style is "plain". See +# http://en.wikipedia.org/wiki/BibTeX for more info. + +LATEX_BIB_STYLE = plain + +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- + +# If the GENERATE_RTF tag is set to YES Doxygen will generate RTF output +# The RTF output is optimized for Word 97 and may not look very pretty with +# other RTF readers or editors. + +GENERATE_RTF = NO + +# The RTF_OUTPUT tag is used to specify where the RTF docs will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `rtf' will be used as the default path. + +RTF_OUTPUT = rtf + +# If the COMPACT_RTF tag is set to YES Doxygen generates more compact +# RTF documents. This may be useful for small projects and may help to +# save some trees in general. + +COMPACT_RTF = YES + +# If the RTF_HYPERLINKS tag is set to YES, the RTF that is generated +# will contain hyperlink fields. The RTF file will +# contain links (just like the HTML output) instead of page references. +# This makes the output suitable for online browsing using WORD or other +# programs which support those fields. +# Note: wordpad (write) and others do not support links. + +RTF_HYPERLINKS = YES + +# Load style sheet definitions from file. Syntax is similar to doxygen's +# config file, i.e. a series of assignments. You only have to provide +# replacements, missing definitions are set to their default value. + +RTF_STYLESHEET_FILE = + +# Set optional variables used in the generation of an rtf document. +# Syntax is similar to doxygen's config file. + +RTF_EXTENSIONS_FILE = + +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- + +# If the GENERATE_MAN tag is set to YES (the default) Doxygen will +# generate man pages + +GENERATE_MAN = NO + +# The MAN_OUTPUT tag is used to specify where the man pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `man' will be used as the default path. + +MAN_OUTPUT = man + +# The MAN_EXTENSION tag determines the extension that is added to +# the generated man pages (default is the subroutine's section .3) + +MAN_EXTENSION = .3 + +# If the MAN_LINKS tag is set to YES and Doxygen generates man output, +# then it will generate one additional man file for each entity +# documented in the real man page(s). These additional files +# only source the real man page, but without them the man command +# would be unable to find the correct page. The default is NO. + +MAN_LINKS = NO + +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- + +# If the GENERATE_XML tag is set to YES Doxygen will +# generate an XML file that captures the structure of +# the code including all documentation. + +GENERATE_XML = NO + +# The XML_OUTPUT tag is used to specify where the XML pages will be put. +# If a relative path is entered the value of OUTPUT_DIRECTORY will be +# put in front of it. If left blank `xml' will be used as the default path. + +XML_OUTPUT = xml + +# The XML_SCHEMA tag can be used to specify an XML schema, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_SCHEMA = + +# The XML_DTD tag can be used to specify an XML DTD, +# which can be used by a validating XML parser to check the +# syntax of the XML files. + +XML_DTD = + +# If the XML_PROGRAMLISTING tag is set to YES Doxygen will +# dump the program listings (including syntax highlighting +# and cross-referencing information) to the XML output. Note that +# enabling this will significantly increase the size of the XML output. + +XML_PROGRAMLISTING = YES + +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- + +# If the GENERATE_AUTOGEN_DEF tag is set to YES Doxygen will +# generate an AutoGen Definitions (see autogen.sf.net) file +# that captures the structure of the code including all +# documentation. Note that this feature is still experimental +# and incomplete at the moment. + +GENERATE_AUTOGEN_DEF = NO + +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- + +# If the GENERATE_PERLMOD tag is set to YES Doxygen will +# generate a Perl module file that captures the structure of +# the code including all documentation. Note that this +# feature is still experimental and incomplete at the +# moment. + +GENERATE_PERLMOD = NO + +# If the PERLMOD_LATEX tag is set to YES Doxygen will generate +# the necessary Makefile rules, Perl scripts and LaTeX code to be able +# to generate PDF and DVI output from the Perl module output. + +PERLMOD_LATEX = NO + +# If the PERLMOD_PRETTY tag is set to YES the Perl module output will be +# nicely formatted so it can be parsed by a human reader. This is useful +# if you want to understand what is going on. On the other hand, if this +# tag is set to NO the size of the Perl module output will be much smaller +# and Perl will parse it just the same. + +PERLMOD_PRETTY = YES + +# The names of the make variables in the generated doxyrules.make file +# are prefixed with the string contained in PERLMOD_MAKEVAR_PREFIX. +# This is useful so different doxyrules.make files included by the same +# Makefile don't overwrite each other's variables. + +PERLMOD_MAKEVAR_PREFIX = + +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- + +# If the ENABLE_PREPROCESSING tag is set to YES (the default) Doxygen will +# evaluate all C-preprocessor directives found in the sources and include +# files. + +ENABLE_PREPROCESSING = YES + +# If the MACRO_EXPANSION tag is set to YES Doxygen will expand all macro +# names in the source code. If set to NO (the default) only conditional +# compilation will be performed. Macro expansion can be done in a controlled +# way by setting EXPAND_ONLY_PREDEF to YES. + +MACRO_EXPANSION = NO + +# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES +# then the macro expansion is limited to the macros specified with the +# PREDEFINED and EXPAND_AS_DEFINED tags. + +EXPAND_ONLY_PREDEF = NO + +# If the SEARCH_INCLUDES tag is set to YES (the default) the includes files +# pointed to by INCLUDE_PATH will be searched when a #include is found. + +SEARCH_INCLUDES = YES + +# The INCLUDE_PATH tag can be used to specify one or more directories that +# contain include files that are not input files but should be processed by +# the preprocessor. + +INCLUDE_PATH = + +# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard +# patterns (like *.h and *.hpp) to filter out the header-files in the +# directories. If left blank, the patterns specified with FILE_PATTERNS will +# be used. + +INCLUDE_FILE_PATTERNS = + +# The PREDEFINED tag can be used to specify one or more macro names that +# are defined before the preprocessor is started (similar to the -D option of +# gcc). The argument of the tag is a list of macros of the form: name +# or name=definition (no spaces). If the definition and the = are +# omitted =1 is assumed. To prevent a macro definition from being +# undefined via #undef or recursively expanded use the := operator +# instead of the = operator. + +PREDEFINED = + +# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then +# this tag can be used to specify a list of macro names that should be expanded. +# The macro definition that is found in the sources will be used. +# Use the PREDEFINED tag if you want to use a different macro definition that +# overrules the definition found in the source code. + +EXPAND_AS_DEFINED = + +# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then +# doxygen's preprocessor will remove all references to function-like macros +# that are alone on a line, have an all uppercase name, and do not end with a +# semicolon, because these will confuse the parser if not removed. + +SKIP_FUNCTION_MACROS = YES + +#--------------------------------------------------------------------------- +# Configuration::additions related to external references +#--------------------------------------------------------------------------- + +# The TAGFILES option can be used to specify one or more tagfiles. For each +# tag file the location of the external documentation should be added. The +# format of a tag file without this location is as follows: +# TAGFILES = file1 file2 ... +# Adding location for the tag files is done as follows: +# TAGFILES = file1=loc1 "file2 = loc2" ... +# where "loc1" and "loc2" can be relative or absolute paths +# or URLs. Note that each tag file must have a unique name (where the name does +# NOT include the path). If a tag file is not located in the directory in which +# doxygen is run, you must also specify the path to the tagfile here. + +TAGFILES = + +# When a file name is specified after GENERATE_TAGFILE, doxygen will create +# a tag file that is based on the input files it reads. + +GENERATE_TAGFILE = + +# If the ALLEXTERNALS tag is set to YES all external classes will be listed +# in the class index. If set to NO only the inherited external classes +# will be listed. + +ALLEXTERNALS = NO + +# If the EXTERNAL_GROUPS tag is set to YES all external groups will be listed +# in the modules index. If set to NO, only the current project's groups will +# be listed. + +EXTERNAL_GROUPS = YES + +# The PERL_PATH should be the absolute path and name of the perl script +# interpreter (i.e. the result of `which perl'). + +PERL_PATH = /usr/bin/perl + +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- + +# If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will +# generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base +# or super classes. Setting the tag to NO turns the diagrams off. Note that +# this option also works with HAVE_DOT disabled, but it is recommended to +# install and use dot, since it yields more powerful graphs. + +CLASS_DIAGRAMS = YES + +# You can define message sequence charts within doxygen comments using the \msc +# command. Doxygen will then run the mscgen tool (see +# http://www.mcternan.me.uk/mscgen/) to produce the chart and insert it in the +# documentation. The MSCGEN_PATH tag allows you to specify the directory where +# the mscgen tool resides. If left empty the tool is assumed to be found in the +# default search path. + +MSCGEN_PATH = E:\mscgen\bin + +# If set to YES, the inheritance and collaboration graphs will hide +# inheritance and usage relations if the target is undocumented +# or is not a class. + +HIDE_UNDOC_RELATIONS = NO + +# If you set the HAVE_DOT tag to YES then doxygen will assume the dot tool is +# available from the path. This tool is part of Graphviz, a graph visualization +# toolkit from AT&T and Lucent Bell Labs. The other options in this section +# have no effect if this option is set to NO (the default) + +HAVE_DOT = YES + +# The DOT_NUM_THREADS specifies the number of dot invocations doxygen is +# allowed to run in parallel. When set to 0 (the default) doxygen will +# base this on the number of processors available in the system. You can set it +# explicitly to a value larger than 0 to get control over the balance +# between CPU load and processing speed. + +DOT_NUM_THREADS = 0 + +# By default doxygen will use the Helvetica font for all dot files that +# doxygen generates. When you want a differently looking font you can specify +# the font name using DOT_FONTNAME. You need to make sure dot is able to find +# the font, which can be done by putting it in a standard location or by setting +# the DOTFONTPATH environment variable or by setting DOT_FONTPATH to the +# directory containing the font. + +DOT_FONTNAME = Helvetica + +# The DOT_FONTSIZE tag can be used to set the size of the font of dot graphs. +# The default size is 10pt. + +DOT_FONTSIZE = 10 + +# By default doxygen will tell dot to use the Helvetica font. +# If you specify a different font using DOT_FONTNAME you can use DOT_FONTPATH to +# set the path where dot can find it. + +DOT_FONTPATH = + +# If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect inheritance relations. Setting this tag to YES will force the +# CLASS_DIAGRAMS tag to NO. + +CLASS_GRAPH = YES + +# If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for each documented class showing the direct and +# indirect implementation dependencies (inheritance, containment, and +# class references variables) of the class with other documented classes. + +COLLABORATION_GRAPH = YES + +# If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen +# will generate a graph for groups, showing the direct groups dependencies + +GROUP_GRAPHS = YES + +# If the UML_LOOK tag is set to YES doxygen will generate inheritance and +# collaboration diagrams in a style similar to the OMG's Unified Modeling +# Language. + +UML_LOOK = YES + +# If the UML_LOOK tag is enabled, the fields and methods are shown inside +# the class node. If there are many fields or methods and many nodes the +# graph may become too big to be useful. The UML_LIMIT_NUM_FIELDS +# threshold limits the number of items for each type to make the size more +# managable. Set this to 0 for no limit. Note that the threshold may be +# exceeded by 50% before the limit is enforced. + +UML_LIMIT_NUM_FIELDS = 10 + +# If set to YES, the inheritance and collaboration graphs will show the +# relations between templates and their instances. + +TEMPLATE_RELATIONS = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT +# tags are set to YES then doxygen will generate a graph for each documented +# file showing the direct and indirect include dependencies of the file with +# other documented files. + +INCLUDE_GRAPH = YES + +# If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDED_BY_GRAPH, and +# HAVE_DOT tags are set to YES then doxygen will generate a graph for each +# documented header file showing the documented files that directly or +# indirectly include this file. + +INCLUDED_BY_GRAPH = YES + +# If the CALL_GRAPH and HAVE_DOT options are set to YES then +# doxygen will generate a call dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable call graphs +# for selected functions only using the \callgraph command. + +CALL_GRAPH = YES + +# If the CALLER_GRAPH and HAVE_DOT tags are set to YES then +# doxygen will generate a caller dependency graph for every global function +# or class method. Note that enabling this option will significantly increase +# the time of a run. So in most cases it will be better to enable caller +# graphs for selected functions only using the \callergraph command. + +CALLER_GRAPH = YES + +# If the GRAPHICAL_HIERARCHY and HAVE_DOT tags are set to YES then doxygen +# will generate a graphical hierarchy of all classes instead of a textual one. + +GRAPHICAL_HIERARCHY = YES + +# If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES +# then doxygen will show the dependencies a directory has on other directories +# in a graphical way. The dependency relations are determined by the #include +# relations between the files in the directories. + +DIRECTORY_GRAPH = YES + +# The DOT_IMAGE_FORMAT tag can be used to set the image format of the images +# generated by dot. Possible values are svg, png, jpg, or gif. +# If left blank png will be used. If you choose svg you need to set +# HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible in IE 9+ (other browsers do not have this requirement). + +DOT_IMAGE_FORMAT = svg + +# If DOT_IMAGE_FORMAT is set to svg, then this option can be set to YES to +# enable generation of interactive SVG images that allow zooming and panning. +# Note that this requires a modern browser other than Internet Explorer. +# Tested and working are Firefox, Chrome, Safari, and Opera. For IE 9+ you +# need to set HTML_FILE_EXTENSION to xhtml in order to make the SVG files +# visible. Older versions of IE do not have SVG support. + +INTERACTIVE_SVG = YES + +# The tag DOT_PATH can be used to specify the path where the dot tool can be +# found. If left blank, it is assumed the dot tool can be found in the path. + +DOT_PATH = E:\graphviz\App\bin + +# The DOTFILE_DIRS tag can be used to specify one or more directories that +# contain dot files that are included in the documentation (see the +# \dotfile command). + +DOTFILE_DIRS = + +# The MSCFILE_DIRS tag can be used to specify one or more directories that +# contain msc files that are included in the documentation (see the +# \mscfile command). + +MSCFILE_DIRS = + +# The DOT_GRAPH_MAX_NODES tag can be used to set the maximum number of +# nodes that will be shown in the graph. If the number of nodes in a graph +# becomes larger than this value, doxygen will truncate the graph, which is +# visualized by representing a node as a red box. Note that doxygen if the +# number of direct children of the root node in a graph is already larger than +# DOT_GRAPH_MAX_NODES then the graph will not be shown at all. Also note +# that the size of a graph can be further restricted by MAX_DOT_GRAPH_DEPTH. + +DOT_GRAPH_MAX_NODES = 60 + +# The MAX_DOT_GRAPH_DEPTH tag can be used to set the maximum depth of the +# graphs generated by dot. A depth value of 3 means that only nodes reachable +# from the root by following a path via at most 3 edges will be shown. Nodes +# that lay further from the root node will be omitted. Note that setting this +# option to 1 or 2 may greatly reduce the computation time needed for large +# code bases. Also note that the size of a graph can be further restricted by +# DOT_GRAPH_MAX_NODES. Using a depth of 0 means no depth restriction. + +MAX_DOT_GRAPH_DEPTH = 0 + +# Set the DOT_TRANSPARENT tag to YES to generate images with a transparent +# background. This is disabled by default, because dot on Windows does not +# seem to support this out of the box. Warning: Depending on the platform used, +# enabling this option may lead to badly anti-aliased labels on the edges of +# a graph (i.e. they become hard to read). + +DOT_TRANSPARENT = NO + +# Set the DOT_MULTI_TARGETS tag to YES allow dot to generate multiple output +# files in one run (i.e. multiple -o and -T options on the command line). This +# makes dot run faster, but since only newer versions of dot (>1.8.10) +# support this, this feature is disabled by default. + +DOT_MULTI_TARGETS = YES + +# If the GENERATE_LEGEND tag is set to YES (the default) Doxygen will +# generate a legend page explaining the meaning of the various boxes and +# arrows in the dot generated graphs. + +GENERATE_LEGEND = YES + +# If the DOT_CLEANUP tag is set to YES (the default) Doxygen will +# remove the intermediate dot files that are used to generate +# the various graphs. + +DOT_CLEANUP = YES diff --git a/dBug.php b/dBug.php index 8413a7e..537ce6a 100755 --- a/dBug.php +++ b/dBug.php @@ -21,6 +21,10 @@ * \*********************************************************************************************************************/ +/*! + @author ospinto + @author KOLANICH +*/ class dBug { var $xmlDepth=array(); @@ -30,19 +34,26 @@ class dBug { var $xmlCount=0; var $xmlAttrib; var $xmlName; - var $arrType=array("array","object","resource","boolean","NULL"); + //var $arrType=array("array",'object',"resource","boolean","NULL"); + + //!shows wheither the main header for this dBug call was drawn var $bInitialized = false; var $bCollapsed = false; var $arrHistory = array(); + static $embeddedStringMaxLength=50; - //constructor + /*! + @param mixed $var Variable to dump + @param string $forceType type to marshall $var to show + @param boolean $bCollapsed should output be collapsed + */ function dBug($var,$forceType="",$bCollapsed=false) { //include js and css scripts if(!defined('BDBUGINIT')) { - define("BDBUGINIT", TRUE); - $this->initJSandCSS(); + define('BDBUGINIT', TRUE); + self::initJSandCSS(); } - $arrAccept=array("array","object","xml"); //array of variable types that can be "forced" + $arrAccept=array("array",'object',"xml"); //array of variable types that can be "forced" $this->bCollapsed = $bCollapsed; if(in_array($forceType,$arrAccept)) $this->{"varIs".ucfirst($forceType)}($var); @@ -81,21 +92,68 @@ function getVariableName() { return ""; } - //create the main table header - function makeTableHeader($type,$header,$colspan=2) { + function initializeHeader(&$header){ if(!$this->bInitialized) { $header = $this->getVariableName() . " (" . $header . ")"; $this->bInitialized = true; } - $str_i = ($this->bCollapsed) ? "style=\"font-style:italic\" " : ""; - - echo " + } + + /*! + @name rendering functions + used to make tables representing different variables + */ + //!@{ + + //!creates the main table header + /*! + @param string $type name of the style of the header cell + @param string $header the text of the header cell + @param integer $colspan colspan property for the header cell + */ + function makeTableHeader($type,$header,$colspan=2) { + $this->initializeHeader($header); + $this->renderTableHeader($type,$header,$colspan); + } + + //!draws the main table header + /*! + @param string $type name of the style of the header cell + @param string $text the text of the header cell + @param integer $colspan colspan property for the header cell + */ + function renderTableHeader($type,$text,$colspan=0){ + echo '
+ + + '; + } + + //!renders table of 2 cells [type][value] + /*! + @param string $headerStyle name of the style of the header cell + @param string $header the text of the header cell + @param string $value the text of the value cell + @param string $valueStyle name of the style of the value cell + @param integer $colspan colspan property for the header cell + */ + function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colspan=0){ + if(!$valueStyle)$valueStyle=$headerStyle; + $this->initializeHeader($header); + echo '
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$type.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleTable(this)">'.$text.'
- - "; + + + '; } - //create the table row header + //!creates the table row header + /*! + @param string $type name of the style of the key cell + @param string $header the text of the key cell + */ function makeTDHeader($type,$header) { $str_d = ($this->bCollapsed) ? " style=\"display:none\"" : ""; echo " @@ -103,12 +161,14 @@ function makeTDHeader($type,$header) { \n"; } + //!@} - //error + + //!prints error function error($type) { $error="Error: Variable cannot be a"; // this just checks if the type starts with a vowel or "x" and displays either "a" or "an" @@ -117,170 +177,186 @@ function error($type) { return ($error." ".$type." type"); } - //check variable type + //!check variable type andd process the value in right way function checkType($var) { $type=gettype($var); switch($type) { - case "resource": + case 'resource': $this->varIsResource($var); break; - case "object": + case 'object': $this->varIsObject($var); break; - case "array": + case 'array': $this->varIsArray($var); break; - case "integer": - case "double": + case 'integer': + case 'double': $this->varIsNumeric($var,$type); break; - case "NULL": + case 'NULL': $this->varIsNULL(); break; - case "boolean": + case 'boolean': $this->varIsBoolean($var); break; - case "string": + case 'string': $this->varIsString($var); break; default: - $var=($var=="") ? "[empty string]" : $var; + $var=($var=='') ? '[empty string]' : $var; echo "
".$header."
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$headerStyle.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleTable(this)">' + .$header. + ''.$value.'
"; } - //close table row + //!closes table row function closeTDRow() { return "
\n\n\n
".$var."
\n"; break; } } - //if variable is a NULL type + /*! + @name functions for rendering different types + */ + //!@{ + + //!renders NULL as red-pink rectangle function varIsNULL() { - $this->makeTableHeader("false","NULL"); - //echo "NULL"; - echo ""; + $this->makeTableHeader('false','NULL'); + echo ''; } - //if variable is a numeric type + //!renders numeric types : integers and doubles function varIsNumeric($var,$type) { - $this->makeTableHeader("numeric",$type."(".$var.")"); - echo ""; + $this->renderPrimitiveType('numeric',$type,$var); + echo ''; } - //if variable is a string type + /*! + renders string either as primitive type (if it is short (less than $embeddedStringMaxLength chars) + and contains of one line) or line-by-line (otherwise) + */ function varIsString(&$var){ - if($var==""){ - $this->makeTableHeader("string","empty string"); - echo ""; + if($var==''){ + $this->makeTableHeader('string','empty string'); + echo ''; return; } - $this->makeTableHeader("string","string (".strlen($var).")"); + $length=strlen($var); $nv=htmlspecialchars($var); $lines=explode("\n",$nv); - foreach($lines as $num=>$line){ - $this->makeTDHeader("string",$num); - echo ($line==""?"[empty line]":$line); - $this->closeTDRow("string"); + $linesCount=count($lines); + if($linesCount==1 && $length<=self::$embeddedStringMaxLength){ + $this->renderPrimitiveType('string','string ['.$length.']',$var); + }else{ + $this->makeTableHeader('string','string ('.$length.' chars @ '.$linesCount.' lines)'); + foreach($lines as $num=>$line){ + $this->makeTDHeader('string',$num); + echo ($line==''?'[empty line]':$line); + $this->closeTDRow('string'); + } } echo ""; } - //if variable is a boolean type + //!renders boolean variable function varIsBoolean(&$var) { - $var?$this->makeTableHeader("numeric","boolean (TRUE)"):$this->makeTableHeader("false","boolean (FALSE)"); - echo $var; - echo ""; + $var?$this->renderPrimitiveType('boolean','boolean','TRUE','booleanTrue'):$this->renderPrimitiveType('boolean','boolean','FALSE','booleanFalse'); + echo ''; } - - //if variable is an array type + + function varIsArray(&$var) { $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); - $this->makeTableHeader("array","array"); + $this->makeTableHeader('array','array'); if(is_array($var)) { foreach($var as $key=>$value) { - $this->makeTDHeader("array",$key); + $this->makeTDHeader('array',$key); //check for recursion if(is_array($value)) { $var_ser = serialize($value); - if(in_array($var_ser, $this->arrHistory, TRUE)) - $value = "*RECURSION*"; + if(in_array($var_ser, $this->arrHistory, TRUE)){ + echo '*RECURSION*'; + echo $this->closeTDRow(); + continue; + } } - if(in_array(gettype($value),$this->arrType)) + //if(in_array(gettype($value),$this->arrType)) $this->checkType($value); - else { + /*else { $value=(trim($value)=="") ? "[empty string]" : $value; echo $value; - } + }*/ echo $this->closeTDRow(); } } - else echo "".$this->error("array").$this->closeTDRow(); + else echo ''.$this->error('array').$this->closeTDRow(); array_pop($this->arrHistory); - echo ""; + echo ''; } - - //if variable is an object type + //! checks wheither variable is object of special type (using varIs*Object), and renders it if it is generic object function varIsObject(&$var) { if($this->varIsDBObject($var))return 1; $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); - $this->makeTableHeader("object","object"); + $this->makeTableHeader('object','object'); if(is_object($var)) { $arrObjVars=get_object_vars($var); foreach($arrObjVars as $key=>$value) { - $value=(!is_object($value) && !is_array($value) && trim($value)=="") ? "[empty string]" : $value; - $this->makeTDHeader("object",$key); + //$value=(!is_object($value) && !is_array($value) && trim($value)=="") ? "[empty string]" : $value; + $this->makeTDHeader('object',$key); //check for recursion if(is_object($value)||is_array($value)) { $var_ser = serialize($value); if(in_array($var_ser, $this->arrHistory, TRUE)) { - $value = (is_object($value)) ? "*RECURSION* -> $".get_class($value) : "*RECURSION*"; - + echo (is_object($value)) ? '*RECURSION* -> $'.get_class($value) : '*RECURSION*'; + echo $this->closeTDRow(); + continue; } } - if(in_array(gettype($value),$this->arrType)) + //if(in_array(gettype($value),$this->arrType)) $this->checkType($value); - else echo $value; + //else + //echo $value; echo $this->closeTDRow(); } $arrObjMethods=get_class_methods(get_class($var)); foreach($arrObjMethods as $key=>$value) { - $this->makeTDHeader("object",$value); - echo "[function]".$this->closeTDRow(); + $this->makeTDHeader('object',$value); + echo '[function]'.$this->closeTDRow(); } } - else echo "".$this->error("object").$this->closeTDRow(); + else echo ''.$this->error('object').$this->closeTDRow(); array_pop($this->arrHistory); - echo ""; + echo ''; } - - //if variable is a resource type + + //!shows info about different resources, uses customized rendering founctions when needed function varIsResource($var) { - $this->makeTableHeader("resourceC","resource",1); + $this->makeTableHeader('resourceC','resource',1); echo "\n\n"; $restype=get_resource_type($var); switch($restype) { - case "fbsql result": - case "mssql result": - case "msql query": - case "pgsql result": - case "sybase-db result": - case "sybase-ct result": - case "mysql result": - $db=current(explode(" ",$restype)); + case 'fbsql result': + case 'mssql result': + case 'msql query': + case 'pgsql result': + case 'sybase-db result': + case 'sybase-ct result': + case 'mysql result': + $db=current(explode(' ',$restype)); $this->varIsDBResource($var,$db); break; - case "gd": + case 'gd': $this->varIsGDResource($var); break; - case "xml": + case 'xml': $this->varIsXmlResource($var); break; - case "curl": + case 'curl': $this->varIsCurlEasyResource($var); break; /*case "curl_multi": @@ -293,13 +369,74 @@ function varIsResource($var) { echo $this->closeTDRow()."\n"; } + //!@} + + /*! + @name functions for rendering different resources + */ + //!@{ + + //!shows information about curl easy handles + /*!simply iterates through handle info and displays everything which is not converted into false*/ + function varIsCurlEasyResource(&$var) { + $this->makeTableHeader('resource','curl easy handle',2); + $info=curl_getinfo($var); + foreach($info as $name=>&$piece){ + if($piece){ + $this->makeTDHeader('resource',$name); + //echo $piece.$this->closeTDRow(); + $this->checkType($piece); + echo $this->closeTDRow(); + } + } + unset($info); + echo ''; + + } + //!not implemented yet + function varIsCurlMultiResource(&$var) { + + } + + //!if variable is an image/gd resource type + function varIsGDResource($var) { + $this->makeTableHeader('resource','gd',2); + $this->makeTDHeader('resource','Width'); + $this->checkType(imagesx($var)); + echo $this->closeTDRow(); + $this->makeTDHeader('resource','Height'); + $this->checkType(imagesy($var)); + echo $this->closeTDRow(); + $this->makeTDHeader('resource','Colors'); + $this->checkType(imagecolorstotal($var)); + echo $this->closeTDRow(); + /*$this->makeTDHeader('resource','Image'); + touch('php://temp'); + imagepng($var,'php://temp'); + $img=file_get_contents('php://temp'); + echo $img; + + echo ''.$this->closeTDRow();*/ + echo ''; + } + + //!@} + + + /*! + @name database results rendering functions + */ + //!@{ + + //!renders either PDO or SQLite3 statement objects + /*!@returns 1 if the object is DB object, 0 otherwise*/ function varIsDBObject($var) { $structure=array(); $data=array(); $retres=false; if($var instanceof SQLite3Result){ //$var=clone $var; - $dbtype=""; + $dbtype=''; $count=$var->numColumns(); for($i=0;$i<$count;$i++){ $structure[$i]=array(); @@ -311,7 +448,7 @@ function varIsDBObject($var) { $data[]=$res; } $var->reset(); - $dbtype="SQLite3"; + $dbtype='SQLite3'; unset($var); $this->renderDBData($dbtype,$structure,$data); $retres=true; @@ -324,13 +461,13 @@ function varIsDBObject($var) { //$col=$var->getColumnMeta(0); $col=$var->getColumnMeta($i); $structure[$i]=array(); - $structure[$i][0]=$col["name"]; - $structure[$i][1]=(isset($col["driver:decl_type"])?(isset($col["len"])?"({$col["len"]})":"")."\n":"")."({$col["native_type"]})"; + $structure[$i][0]=$col['name']; + $structure[$i][1]=(isset($col['driver:decl_type'])?(isset($col["len"])?"({$col["len"]})":'')."\n":'')."({$col["native_type"]})"; } unset($col); $data=$var->fetchAll(); $var->closeCursor(); - $dbtype="PDOStatement"; + $dbtype='PDOStatement'; unset($var); $this->renderDBData($dbtype,$structure,$data); $retres=true; @@ -340,44 +477,51 @@ function varIsDBObject($var) { unset($structure); return $retres; } + + //!renders database data + /*! + @param string $objectType type of the db, it is only the name of header now + @param array $structure 'header' of the table - columns names and types + @param array $data rows of sql request result + */ function renderDBData(&$objectType,&$structure,&$data){ - $this->makeTableHeader("database",$objectType,count($structure)+1); - echo " "; + $this->makeTableHeader('database',$objectType,count($structure)+1); + echo ' '; foreach($structure as $field) { echo ''.$field[0].""; } - echo ""; + echo ''; if(empty($data)){ - echo "[empty result]"; + echo '[empty result]'; }else $i=0; foreach($data as $row) { echo "\n"; - echo "".(++$i).""; + echo ''.(++$i).''; for($k=0;$k".$fieldrow."\n"; + $fieldrow=($row[$k]==='') ? '[empty string]' : $row[$k]; + echo ''.$fieldrow."\n"; } echo "\n"; } - echo ""; + echo ''; } - //if variable is a database resource type - function varIsDBResource($var,$db="mysql") { - if($db == "pgsql") - $db = "pg"; - if($db == "sybase-db" || $db == "sybase-ct") - $db = "sybase"; - $arrFields = array("name","type","flags"); - $numrows=call_user_func($db."_num_rows",$var); - $numfields=call_user_func($db."_num_fields",$var); - $this->makeTableHeader("database",$db." result",$numfields+1); - echo " "; + //!renders database resource (fetch result) into table or ... smth else + function varIsDBResource($var,$db='mysql') { + if($db == 'pgsql') + $db = 'pg'; + if($db == 'sybase-db' || $db == 'sybase-ct') + $db = 'sybase'; + $arrFields = array('name','type','flags'); + $numrows=call_user_func($db.'_num_rows',$var); + $numfields=call_user_func($db.'_num_fields',$var); + $this->makeTableHeader('database',$db.' result',$numfields+1); + echo ' '; for($i=0;$i<$numfields;$i++) { - $field_header = ""; + $field_header = ''; for($j=0; $j".$field_name.""; + $field[$i]=call_user_func($db.'_fetch_field',$var,$i); + echo ''.$field_name.''; } - echo ""; + echo ''; for($i=0;$i<$numrows;$i++) { $row=call_user_func($db."_fetch_array",$var,constant(strtoupper($db)."_ASSOC")); echo "\n"; - echo "".($i+1).""; + echo ''.($i+1).''; for($k=0;$k<$numfields;$k++) { $tempField=$field[$k]->name; $fieldrow=$row[($field[$k]->name)]; - $fieldrow=($fieldrow=="") ? "[empty string]" : $fieldrow; - echo "".$fieldrow."\n"; + $fieldrow=($fieldrow=='') ? '[empty string]' : $fieldrow; + echo ''.$fieldrow."\n"; } echo "\n"; } - echo ""; + echo ''; if($numrows>0) - call_user_func($db."_data_seek",$var,0); + call_user_func($db.'_data_seek',$var,0); } + //!@} - //if variable is an image/gd resource type - function varIsGDResource($var) { - $this->makeTableHeader("resource","gd",2); - $this->makeTDHeader("resource","Width"); - echo imagesx($var).$this->closeTDRow(); - $this->makeTDHeader("resource","Height"); - echo imagesy($var).$this->closeTDRow(); - $this->makeTDHeader("resource","Colors"); - echo imagecolorstotal($var).$this->closeTDRow(); - /*$this->makeTDHeader("resource","Image"); - touch('php://temp'); - imagepng($var,'php://temp'); - $img=file_get_contents('php://temp'); - echo $img; - - echo ''.$this->closeTDRow();*/ - echo ""; - } + /*! + @name xml rendering functions + */ + //!@{ - //if variable is an xml type + //!if variable is an xml type + //!remember, that you must force type to xml to use this function varIsXml($var) { $this->varIsXmlResource($var); } - //if variable is an xml resource type + //!if variable is an xml resource type function varIsXmlResource($var) { $xml_parser=xml_parser_create(); xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0); - xml_set_element_handler($xml_parser,array(&$this,"xmlStartElement"),array(&$this,"xmlEndElement")); - xml_set_character_data_handler($xml_parser,array(&$this,"xmlCharacterData")); - xml_set_default_handler($xml_parser,array(&$this,"xmlDefaultHandler")); + xml_set_element_handler($xml_parser,array(&$this,'xmlStartElement'),array(&$this,'xmlEndElement')); + xml_set_character_data_handler($xml_parser,array(&$this,'xmlCharacterData')); + xml_set_default_handler($xml_parser,array(&$this,'xmlDefaultHandler')); - $this->makeTableHeader("xml","xml document",2); - $this->makeTDHeader("xml","xmlRoot"); + $this->makeTableHeader('xml','xml document',2); + $this->makeTDHeader('xml','xmlRoot'); //attempt to open xml file - $bFile=(!($fp=@fopen($var,"r"))) ? false : true; + $bFile=(!($fp=@fopen($var,'r'))) ? false : true; //read xml file if($bFile) { - while($data=str_replace("\n","",fread($fp,4096))) + while($data=str_replace("\n",'',fread($fp,4096))) $this->xmlParse($xml_parser,$data,feof($fp)); } //if xml is not a file, attempt to read it as a string else { if(!is_string($var)) { - echo $this->error("xml").$this->closeTDRow()."\n"; + echo $this->error('xml').$this->closeTDRow()."\n"; return; } $data=$var; @@ -464,24 +596,7 @@ function varIsXmlResource($var) { } - function varIsCurlEasyResource(&$var) { - $this->makeTableHeader("resource","curl easy handle",2); - $info=curl_getinfo($var); - foreach($info as $name=>&$piece){ - if($piece){ - $this->makeTDHeader("resource",$name); - echo $piece.$this->closeTDRow(); - } - } - unset($info); - echo ""; - - } - function varIsCurlMultiResource(&$var) { - - } - - //parse xml + //!parses xml function xmlParse($xml_parser,$data,$bFinal) { if (!xml_parse($xml_parser,$data,$bFinal)) { die(sprintf("XML error: %s at line %d\n", @@ -490,7 +605,7 @@ function xmlParse($xml_parser,$data,$bFinal) { } } - //xml: inititiated when a start tag is encountered + //!xml: inititiated when a start tag is encountered function xmlStartElement($parser,$name,$attribs) { $this->xmlAttrib[$this->xmlCount]=$attribs; $this->xmlName[$this->xmlCount]=$name; @@ -506,7 +621,7 @@ function xmlStartElement($parser,$name,$attribs) { $this->xmlCount++; } - //xml: initiated when an end tag is encountered + //!xml: initiated when an end tag is encountered function xmlEndElement($parser,$name) { for($i=0;$i<$this->xmlCount;$i++) { eval($this->xmlSData[$i]); @@ -516,15 +631,15 @@ function xmlEndElement($parser,$name) { $this->makeTDHeader("xml","xmlComment"); echo (!empty($this->xmlDData[$i])) ? $this->xmlDData[$i] : " "; echo $this->closeTDRow(); - $this->makeTDHeader("xml","xmlChildren"); + $this->makeTDHeader('xml',"xmlChildren"); unset($this->xmlCData[$i],$this->xmlDData[$i]); } echo $this->closeTDRow(); - echo ""; + echo ''; $this->xmlCount=0; } - //xml: initiated when text between tags is encountered + //!xml: initiated when text between tags is encountered function xmlCharacterData($parser,$data) { $count=$this->xmlCount-1; if(!empty($this->xmlCData[$count])) @@ -533,7 +648,9 @@ function xmlCharacterData($parser,$data) { $this->xmlCData[$count]=$data; } - //xml: initiated when a comment or other miscellaneous texts is encountered + //!@} + + //!xml: initiated when a comment or other miscellaneous texts is encountered function xmlDefaultHandler($parser,$data) { //strip '' off comments $data=str_replace(array("<!--","-->"),"",htmlspecialchars($data)); @@ -543,8 +660,9 @@ function xmlDefaultHandler($parser,$data) { else $this->xmlDData[$count]=$data; } - - function initJSandCSS() { + + //! adds needed JS and CSS sources to page + static function initJSandCSS() { echo << /* code modified from ColdFusion's cfdump code */ @@ -639,26 +757,37 @@ function dBug_toggleTable(source) { table.dBug_xml td { background-color:#FFFFFF; } table.dBug_xml td.dBug_xmlHeader { background-color:#AAAAAA; } table.dBug_xml td.dBug_xmlKey { background-color:#DDDDDD; } - /* FALSE */ + + /* FALSE and boolean false*/ table.dBug_false { background-color:#CB0101; } table.dBug_false td { background-color:#FFFFFF; } - table.dBug_false td.dBug_falseHeader { background-color:#F2054C; } + table.dBug_boolean td.dBug_booleanFalse,table.dBug_false td.dBug_falseHeader { background-color:#F2054C; } table.dBug_false td.dBug_falseKey { background-color:#DDDDDD; } + /* numeric */ table.dBug_numeric { background-color:#F9C007; } table.dBug_numeric td { background-color:#FFFFFF; } table.dBug_numeric td.dBug_numericHeader { background-color:#F2D904; } - /*table.dBug_numeric td.dBug_numericKey { background-color:#DDDDDD; }*/ + //table.dBug_numeric td.dBug_numericKey { background-color:#DDDDDD; } + /* database */ table.dBug_database { background-color:#8FB6E6 } table.dBug_database td { background-color:#07DDF9; } table.dBug_database td.dBug_databaseHeader { background-color:#07F7FB; } table.dBug_database td.dBug_databaseKey { background-color:#AEF4F5; } + /* string */ table.dBug_string { background-color:#556832 } table.dBug_string td { background-color:#B3C520;} table.dBug_string td.dBug_stringHeader { background-color:#808000; } table.dBug_string td.dBug_stringKey { background-color:#96A428; } + + /*boolean*/ + table.dBug_boolean { background-color:#43769F } + table.dBug_boolean td.dBug_booleanHeader { background-color:#5EA5DE; } + table.dBug_boolean td.dBug_booleanTrue { background-color:#04F258; } + table.dBug_boolean td.dBug_booleanTrue,table.dBug_boolean td.dBug_booleanFalse { width:46px; text-align: center;border-radius: 45%;} + SCRIPTS; } diff --git a/tests.php b/tests.php index dc5dedc..4d746eb 100644 --- a/tests.php +++ b/tests.php @@ -1,19 +1,30 @@ "1", "second", "third"=>array( "inner third 1", - "inner third 2"=>"yeah"), - "fourth"); + "inner third 2"=>25), + "fourth"=>49.36, + 'fifth'=>true, + 6=>false, + NULL, + ); new dBug($variable); class Vegetable { From de5c15f13afcd7a7c8f84a97cf078f507385c896 Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Sat, 8 Dec 2012 23:25:24 +0400 Subject: [PATCH 11/26] Create README.md --- README.md | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/README.md b/README.md index 839418c..a008f40 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -# dBug +dBug +==== -## How to use +my mod of dBug +A debug output library which is used to visualize different datatypes. +Initially was developed by ospinto. - include_once("dBug.php"); - new dBug($myVariable); +For more info visit [http://kolanich.github.com/dBug/] -More examples at http://dbug.ospinto.com/examples.php +## Very very brief list of features -## Features - -PHP version of ColdFusion’s cfdump. +PHP version of ColdFusions cfdump. Outputs colored and structured tabular variable information. @@ -22,4 +22,4 @@ Stylesheet can be easily edited. Table cells can be expanded and collapsed. -It’s FREE!!! +Its FREE!!! From 6077a0631946d3cc7faecd153728169f65f0d23e Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Sat, 29 Dec 2012 20:19:06 +0400 Subject: [PATCH 12/26] Added Exception rendering some bugs fixed --- dBug.php | 130 ++++++++++++++++++++++++++++++++++++++++++++++-------- tests.php | 22 ++++++++- 2 files changed, 132 insertions(+), 20 deletions(-) diff --git a/dBug.php b/dBug.php index 537ce6a..fb1480e 100755 --- a/dBug.php +++ b/dBug.php @@ -129,7 +129,7 @@ function renderTableHeader($type,$text,$colspan=0){ '; } - //!renders table of 2 cells [type][value] + //!renders table of 2 cells in 1 row [type][value] /*! @param string $headerStyle name of the style of the header cell @param string $header the text of the header cell @@ -142,11 +142,10 @@ function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colsp $this->initializeHeader($header); echo ' - - - '; + '; } //!creates the table row header @@ -155,10 +154,9 @@ function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colsp @param string $header the text of the key cell */ function makeTDHeader($type,$header) { - $str_d = ($this->bCollapsed) ? " style=\"display:none\"" : ""; - echo " - - +
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$headerStyle.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleTable(this)">' + bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$headerStyle.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleRow(this)">' .$header. ''.$value.'
'.$value.'
".$header.""; + echo 'bCollapsed ? ' style="display:none"' : '').'> + '.$header.''; } //!closes table row @@ -170,7 +168,7 @@ function closeTDRow() { //!prints error function error($type) { - $error="Error: Variable cannot be a"; + $error='Error: Variable cannot be a'; // this just checks if the type starts with a vowel or "x" and displays either "a" or "an" if(in_array(substr($type,0,1),array("a","e","i","o","u","x"))) $error.="n"; @@ -295,8 +293,7 @@ function varIsArray(&$var) { } //! checks wheither variable is object of special type (using varIs*Object), and renders it if it is generic object function varIsObject(&$var) { - if($this->varIsDBObject($var))return 1; - + if($this->varIsSpecialObject($var))return 1; $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); $this->makeTableHeader('object','object'); @@ -334,6 +331,16 @@ function varIsObject(&$var) { echo '
'; } + function varIsSpecialObject(&$var){ + if($this->varIsDBObject($var))return 1; + if($var instanceof Exception){ + $this->varIsException($var); + return 1; + } + return 0; + } + + //!shows info about different resources, uses customized rendering founctions when needed function varIsResource($var) { $this->makeTableHeader('resourceC','resource',1); @@ -535,7 +542,7 @@ function varIsDBResource($var,$db='mysql') { } echo ''; for($i=0;$i<$numrows;$i++) { - $row=call_user_func($db."_fetch_array",$var,constant(strtoupper($db)."_ASSOC")); + $row=call_user_func($db.'_fetch_array',$var,constant(strtoupper($db).'_ASSOC')); echo "\n"; echo ''.($i+1).''; for($k=0;$k<$numfields;$k++) { @@ -552,6 +559,63 @@ function varIsDBResource($var,$db='mysql') { } //!@} + + /*! + @name other special kinds of objects rendering functionality + */ + //!@{ + + //!array of properties of every exception to be rendered first + static $exceptionMainProps=array('message','code','file','line'); + //!array of properties of Exception of not to be rendered + static $exceptionExcludedProps=array( + //'xdebug_message', + 'trace' + ); + + //!function used to render exceptions + /*! + Renders exceptions : at first basic fields, then custom fields. + Custom private and protected fields are rendered if reflection api is available + */ + function varIsException(&$var) { + $code=$var->getCode(); + $this->makeTableHeader('Exception',get_class($var).' :: '.$code); + foreach(static::$exceptionMainProps as &$pname) { + $this->makeTDHeader('Exception',$pname); + $this->checkType($var->{'get'.ucfirst($pname)}()); + echo $this->closeTDRow(); + } + unset($pname); + echo ''; + if(extension_loaded('Reflection')){ + $refl=new ReflectionObject($var); + $props=$refl->getProperties(ReflectionProperty::IS_PROTECTED|ReflectionProperty::IS_PRIVATE); + foreach($props as &$prop) { + $pname=$prop->getName(); + if(in_array($pname,static::$exceptionMainProps)||in_array($pname,static::$exceptionExcludedProps))continue; + $this->makeTDHeader('Exception',$pname); + $prop->setAccessible(true); + $this->checkType($prop->getValue($var)); + $prop->setAccessible(false); + echo $this->closeTDRow(); + } + } + + foreach($var as $key=>&$value) { + if($key=='xdebug_message')continue; + $this->makeTDHeader('Exception',$key); + $this->checkType($value); + echo $this->closeTDRow(); + } + + echo ''; + } + + //!@} + + + /*! @name xml rendering functions */ @@ -709,7 +773,7 @@ function dBug_toggleTable(source) { -SCRIPTS; - } - -} -?> \ No newline at end of file +bCollapsed = $bCollapsed; + if(in_array($forceType,$arrAccept)) + $this->{"varIs".ucfirst($forceType)}($var); + else + $this->checkType($var); + } + + //get variable name + function getVariableName() { + $arrBacktrace = debug_backtrace(); + + //possible 'included' functions + $arrInclude = array("include","include_once","require","require_once"); + + //check for any included/required files. if found, get array of the last included file (they contain the right line numbers) + for($i=count($arrBacktrace)-1; $i>=0; $i--) { + $arrCurrent = $arrBacktrace[$i]; + if(array_key_exists("function", $arrCurrent) && + (in_array($arrCurrent["function"], $arrInclude) || (0 != strcasecmp($arrCurrent["function"], "dbug")))) + continue; + + $arrFile = $arrCurrent; + + break; + } + + if(isset($arrFile)) { + $arrLines = file($arrFile["file"]); + $code = $arrLines[($arrFile["line"]-1)]; + + //find call to dBug class + preg_match('/\bnew dBug\s*\(\s*(.+)\s*\);/i', $code, $arrMatches); + + return isset($arrMatches[1])?$arrMatches[1]:'[multiline]'; + } + return ""; + } + + function initializeHeader(&$header){ + if(!$this->bInitialized) { + $header = $this->getVariableName() . " (" . $header . ")"; + $this->bInitialized = true; + } + } + + /*! + @name rendering functions + used to make tables representing different variables + */ + //!@{ + + //!creates the main table header + /*! + @param string $type name of the style of the header cell + @param string $header the text of the header cell + @param integer $colspan colspan property for the header cell + */ + function makeTableHeader($type,$header,$colspan=2) { + $this->initializeHeader($header); + $this->renderTableHeader($type,$header,$colspan); + } + + //!draws the main table header + /*! + @param string $type name of the style of the header cell + @param string $text the text of the header cell + @param integer $colspan colspan property for the header cell + */ + function renderTableHeader($type,$text,$colspan=0){ + echo ' + + + '; + } + + //!renders table of 2 cells in 1 row [type][value] + /*! + @param string $headerStyle name of the style of the header cell + @param string $header the text of the header cell + @param string $value the text of the value cell + @param string $valueStyle name of the style of the value cell + @param integer $colspan colspan property for the header cell + */ + function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colspan=0){ + if(!$valueStyle)$valueStyle=$headerStyle; + $this->initializeHeader($header); + echo '
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$type.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleTable(this)">'.$text.'
+ + + '; + } + + //!creates the table row header + /*! + @param string $type name of the style of the key cell + @param string $header the text of the key cell + */ + function makeTDHeader($type,$header) { + echo 'bCollapsed ? ' style="display:none"' : '').'> + + \n"; + } + //!@} + + + //!prints error + function error($type) { + $error='Error: Variable cannot be a'; + // this just checks if the type starts with a vowel or "x" and displays either "a" or "an" + if(in_array(substr($type,0,1),array("a","e","i","o","u","x"))) + $error.="n"; + return ($error." ".$type." type"); + } + + //!check variable type andd process the value in right way + function checkType($var) { + $type=gettype($var); + switch($type) { + case 'resource': + $this->varIsResource($var); + break; + case 'object': + $this->varIsObject($var); + break; + case 'array': + $this->varIsArray($var); + break; + case 'integer': + case 'double': + $this->varIsNumeric($var,$type); + break; + case 'NULL': + $this->varIsNULL(); + break; + case 'boolean': + $this->varIsBoolean($var); + break; + case 'string': + $this->varIsString($var); + break; + default: + $var=($var=='') ? '[empty string]' : $var; + echo "
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$headerStyle.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleRow(this)">' + .$header. + ''.$value.'
'.$header.''; + } + + //!closes table row + function closeTDRow() { + return "
\n\n\n
".$var."
\n"; + break; + } + } + + /*! + @name functions for rendering different types + */ + //!@{ + + //!renders NULL as red-pink rectangle + function varIsNULL() { + $this->makeTableHeader('false','NULL'); + echo ''; + } + + //!renders numeric types : integers and doubles + function varIsNumeric($var,$type) { + $this->renderPrimitiveType('numeric',$type,$var); + echo ''; + } + + /*! + renders string either as primitive type (if it is short (less than $embeddedStringMaxLength chars) + and contains of one line) or line-by-line (otherwise) + */ + function varIsString(&$var){ + if($var==''){ + $this->makeTableHeader('string','empty string'); + echo ''; + return; + } + $length=strlen($var); + $nv=htmlspecialchars($var,ENT_QUOTES | ENT_SUBSTITUTE,''); + $lines=preg_split('/\R/', $nv); + $linesCount=count($lines); + if($linesCount==1 && $length<=self::$embeddedStringMaxLength){ + $this->renderPrimitiveType('string','string ['.$length.']',$var); + }else{ + $this->makeTableHeader('string','string ('.$length.' chars @ '.$linesCount.' lines)'); + foreach($lines as $num=>$line){ + $this->makeTDHeader('string',$num); + echo ($line==''?'[empty line]':$line); + $this->closeTDRow('string'); + } + } + echo ""; + } + + //!renders boolean variable + function varIsBoolean(&$var) { + $var?$this->renderPrimitiveType('boolean','boolean','TRUE','booleanTrue'):$this->renderPrimitiveType('boolean','boolean','FALSE','booleanFalse'); + echo ''; + } + + + function varIsArray(&$var) { + $var_ser = serialize($var); + array_push($this->arrHistory, $var_ser); + + $this->makeTableHeader('array','array'); + if(is_array($var)) { + foreach($var as $key=>$value) { + $this->makeTDHeader('array',$key); + + //check for recursion + if(is_array($value)) { + $var_ser = serialize($value); + if(in_array($var_ser, $this->arrHistory, TRUE)){ + echo '*RECURSION*'; + echo $this->closeTDRow(); + continue; + } + } + + //if(in_array(gettype($value),$this->arrType)) + $this->checkType($value); + /*else { + $value=(trim($value)=="") ? "[empty string]" : $value; + echo $value; + }*/ + echo $this->closeTDRow(); + } + } + else echo ''.$this->error('array').$this->closeTDRow(); + array_pop($this->arrHistory); + echo ''; + } + + + + //! checks wheither variable is object of special type (using varIs*Object), and renders it if it is generic object + function varIsObject(&$var) { + if($this->varIsSpecialObject($var))return 1; + $var_ser = serialize($var); + array_push($this->arrHistory, $var_ser); + + if(is_object($var)) { + $this->makeTableHeader('object','object ( '.get_class($var).' )'); + if(method_exists($var,'__toString')){ + $str=$var->__toString(); + if($str!==null){ + $this->makeTDHeader('string','[string representation]'); + $this->varIsString($str); + echo $this->closeTDRow(); + } + } + $arrObjVars=get_object_vars($var); + foreach($arrObjVars as $key=>$value) { + + //$value=(!is_object($value) && !is_array($value) && trim($value)=="") ? "[empty string]" : $value; + $this->makeTDHeader('object',$key); + + //check for recursion + if(is_object($value)||is_array($value)) { + $var_ser = serialize($value); + if(in_array($var_ser, $this->arrHistory, TRUE)) { + echo (is_object($value)) ? '*RECURSION* -> $'.get_class($value) : '*RECURSION*'; + echo $this->closeTDRow(); + continue; + } + } + //if(in_array(gettype($value),$this->arrType)) + $this->checkType($value); + //else + //echo $value; + echo $this->closeTDRow(); + } + $arrObjMethods=get_class_methods(get_class($var)); + foreach($arrObjMethods as $key=>$value) { + $this->makeTDHeader('object',$value); + echo '[function]'.$this->closeTDRow(); + } + if($var instanceof \Iterator){ + foreach($var as $key=>$value) { + $this->makeTDHeader('array',$key); + $this->checkType($value); + echo $this->closeTDRow(); + } + } + } + else{ + $this->makeTableHeader('object','object'); + echo ''.$this->error('object').$this->closeTDRow(); + } + array_pop($this->arrHistory); + echo ''; + } + + function varIsSpecialObject(&$var){ + if($this->varIsDBObject($var))return 1; + if($var instanceof Exception){ + $this->varIsException($var); + return 1; + } + return 0; + } + + + //!shows info about different resources, uses customized rendering founctions when needed + function varIsResource($var) { + $this->makeTableHeader('resourceC','resource',1); + echo "\n\n"; + $restype=get_resource_type($var); + switch($restype) { + case 'fbsql result': + case 'mssql result': + case 'msql query': + case 'pgsql result': + case 'sybase-db result': + case 'sybase-ct result': + case 'mysql result': + $db=current(explode(' ',$restype)); + $this->varIsDBResource($var,$db); + break; + case 'gd': + $this->varIsGDResource($var); + break; + case 'xml': + $this->varIsXmlResource($var); + break; + case 'curl': + $this->varIsCurlEasyResource($var); + break; + /*case "curl_multi": + $this->varIsCurlMultiResource($var); + break;*/ + default: + echo $restype.$this->closeTDRow(); + break; + } + echo $this->closeTDRow()."\n"; + } + + //!@} + + /*! + @name functions for rendering different resources + */ + //!@{ + + //!shows information about curl easy handles + /*!simply iterates through handle info and displays everything which is not converted into false*/ + function varIsCurlEasyResource(&$var) { + $this->makeTableHeader('resource','curl easy handle',2); + $info=curl_getinfo($var); + foreach($info as $name=>&$piece){ + if($piece){ + $this->makeTDHeader('resource',$name); + //echo $piece.$this->closeTDRow(); + $this->checkType($piece); + echo $this->closeTDRow(); + } + } + unset($info); + echo ''; + + } + //!not implemented yet + function varIsCurlMultiResource(&$var) { + + } + + //!if variable is an image/gd resource type + function varIsGDResource(&$var) { + $this->makeTableHeader('resource','gd',2); + $this->makeTDHeader('resource','Width'); + $this->checkType(imagesx($var)); + echo $this->closeTDRow(); + $this->makeTDHeader('resource','Height'); + $this->checkType(imagesy($var)); + echo $this->closeTDRow(); + $this->makeTDHeader('resource','Colors'); + $this->checkType(imageistruecolor($var)?'TrueColor (16 777 216)':imagecolorstotal($var)); + echo $this->closeTDRow(); + + $this->makeTDHeader('resource','Image'); + + + + ob_start(); + imagepng($var); + $img = ob_get_clean(); + + echo ''.$this->closeTDRow(); + echo ''; + } + + //!@} + + + /*! + @name database results rendering functions + */ + //!@{ + + //!renders either PDO or SQLite3 statement objects + /*!@returns 1 if the object is DB object, 0 otherwise*/ + function varIsDBObject($var) { + $structure=array(); + $data=array(); + $retres=false; + if($var instanceof SQLite3Result){ + //$var=clone $var; + $dbtype=''; + $count=$var->numColumns(); + for($i=0;$i<$count;$i++){ + $structure[$i]=array(); + $structure[$i][0]=$var->columnName($i); + $structure[$i][1]=$var->columnType($i); + } + $var->reset(); + while($res=$var->fetchArray(SQLITE3_NUM)){ + $data[]=$res; + } + $var->reset(); + $dbtype='SQLite3'; + unset($var); + $this->renderDBData($dbtype,$structure,$data); + $retres=true; + } + if($var instanceof PDOStatement){ + //$var=clone $var; + $count=$var->columnCount(); + $col=null; + for($i=0;$i<$count;$i++){ + //$col=$var->getColumnMeta(0); + $col=$var->getColumnMeta($i); + $structure[$i]=array(); + $structure[$i][0]=$col['name']; + $structure[$i][1]=(isset($col['driver:decl_type'])?(isset($col["len"])?"({$col["len"]})":'')."\n":'')."({$col["native_type"]})"; + } + unset($col); + $data=$var->fetchAll(); + $var->closeCursor(); + $dbtype='PDOStatement'; + unset($var); + $this->renderDBData($dbtype,$structure,$data); + $retres=true; + } + unset($dbtype); + unset($data); + unset($structure); + return $retres; + } + + //!renders database data + /*! + @param string $objectType type of the db, it is only the name of header now + @param array $structure 'header' of the table - columns names and types + @param array $data rows of sql request result + */ + function renderDBData(&$objectType,&$structure,&$data){ + $this->makeTableHeader('database',$objectType,count($structure)+1); + echo ' '; + foreach($structure as $field) { + echo ''.$field[0].""; + } + echo ''; + if(empty($data)){ + echo '[empty result]'; + }else + $i=0; + foreach($data as $row) { + echo "\n"; + echo ''.(++$i).''; + for($k=0;$k'.$fieldrow."\n"; + } + echo "\n"; + } + echo ''; + } + + //!renders database resource (fetch result) into table or ... smth else + function varIsDBResource($var,$db='mysql') { + if($db == 'pgsql') + $db = 'pg'; + if($db == 'sybase-db' || $db == 'sybase-ct') + $db = 'sybase'; + $arrFields = array('name','type','flags'); + $numrows=call_user_func($db.'_num_rows',$var); + $numfields=call_user_func($db.'_num_fields',$var); + $this->makeTableHeader('database',$db.' result',$numfields+1); + echo ' '; + for($i=0;$i<$numfields;$i++) { + $field_header = ''; + for($j=0; $j'.$field_name.''; + } + echo ''; + for($i=0;$i<$numrows;$i++) { + $row=call_user_func($db.'_fetch_array',$var,constant(strtoupper($db).'_ASSOC')); + echo "\n"; + echo ''.($i+1).''; + for($k=0;$k<$numfields;$k++) { + $tempField=$field[$k]->name; + $fieldrow=$row[($field[$k]->name)]; + $fieldrow=($fieldrow=='') ? '[empty string]' : $fieldrow; + echo ''.$fieldrow."\n"; + } + echo "\n"; + } + echo ''; + if($numrows>0) + call_user_func($db.'_data_seek',$var,0); + } + //!@} + + + /*! + @name other special kinds of objects rendering functionality + */ + //!@{ + + //!array of properties of every exception to be rendered first + static $exceptionMainProps=array('message','code','file','line'); + //!array of properties of Exception of not to be rendered + static $exceptionExcludedProps=array( + //'xdebug_message', + 'trace' + ); + + //!function used to render exceptions + /*! + Renders exceptions : at first basic fields, then custom fields. + Custom private and protected fields are rendered if reflection api is available + */ + function varIsException(&$var) { + $code=$var->getCode(); + $this->makeTableHeader('Exception',get_class($var).' :: '.$code); + foreach(static::$exceptionMainProps as &$pname) { + $this->makeTDHeader('Exception',$pname); + $this->checkType($var->{'get'.ucfirst($pname)}()); + echo $this->closeTDRow(); + } + unset($pname); + echo ''; + if(extension_loaded('Reflection')){ + $refl=new ReflectionObject($var); + $props=$refl->getProperties(ReflectionProperty::IS_PROTECTED|ReflectionProperty::IS_PRIVATE); + foreach($props as &$prop) { + $pname=$prop->getName(); + if(in_array($pname,static::$exceptionMainProps)||in_array($pname,static::$exceptionExcludedProps))continue; + $this->makeTDHeader('Exception',$pname); + $prop->setAccessible(true); + $this->checkType($prop->getValue($var)); + $prop->setAccessible(false); + echo $this->closeTDRow(); + } + } + + foreach($var as $key=>&$value) { + if($key=='xdebug_message')continue; + $this->makeTDHeader('Exception',$key); + $this->checkType($value); + echo $this->closeTDRow(); + } + + echo ''; + } + + //!@} + + + + /*! + @name xml rendering functions + */ + //!@{ + + //!if variable is an xml type + //!remember, that you must force type to xml to use this + function varIsXml($var) { + $this->varIsXmlResource($var); + } + + //!if variable is an xml resource type + function varIsXmlResource($var) { + $xml_parser=xml_parser_create(); + xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0); + xml_set_element_handler($xml_parser,array(&$this,'xmlStartElement'),array(&$this,'xmlEndElement')); + xml_set_character_data_handler($xml_parser,array(&$this,'xmlCharacterData')); + xml_set_default_handler($xml_parser,array(&$this,'xmlDefaultHandler')); + + $this->makeTableHeader('xml','xml document',2); + $this->makeTDHeader('xml','xmlRoot'); + + //attempt to open xml file + $bFile=(!($fp=@fopen($var,'r'))) ? false : true; + + //read xml file + if($bFile) { + while($data=str_replace("\n",'',fread($fp,4096))) + $this->xmlParse($xml_parser,$data,feof($fp)); + } + //if xml is not a file, attempt to read it as a string + else { + if(!is_string($var)) { + echo $this->error('xml').$this->closeTDRow()."\n"; + return; + } + $data=$var; + $this->xmlParse($xml_parser,$data,1); + } + + echo $this->closeTDRow()."\n"; + + } + + //!parses xml + function xmlParse($xml_parser,$data,$bFinal) { + if (!xml_parse($xml_parser,$data,$bFinal)) { + die(sprintf("XML error: %s at line %d\n", + xml_error_string(xml_get_error_code($xml_parser)), + xml_get_current_line_number($xml_parser))); + } + } + + //!xml: inititiated when a start tag is encountered + function xmlStartElement($parser,$name,$attribs) { + $this->xmlAttrib[$this->xmlCount]=$attribs; + $this->xmlName[$this->xmlCount]=$name; + $this->xmlSData[$this->xmlCount]='$this->makeTableHeader("xml","xml element",2);'; + $this->xmlSData[$this->xmlCount].='$this->makeTDHeader("xml","xmlName");'; + $this->xmlSData[$this->xmlCount].='echo "'.$this->xmlName[$this->xmlCount].'".$this->closeTDRow();'; + $this->xmlSData[$this->xmlCount].='$this->makeTDHeader("xml","xmlAttributes");'; + if(count($attribs)>0) + $this->xmlSData[$this->xmlCount].='$this->varIsArray($this->xmlAttrib['.$this->xmlCount.']);'; + else + $this->xmlSData[$this->xmlCount].='echo " ";'; + $this->xmlSData[$this->xmlCount].='echo $this->closeTDRow();'; + $this->xmlCount++; + } + + //!xml: initiated when an end tag is encountered + function xmlEndElement($parser,$name) { + for($i=0;$i<$this->xmlCount;$i++) { + eval($this->xmlSData[$i]); + $this->makeTDHeader("xml","xmlText"); + echo (!empty($this->xmlCData[$i])) ? $this->xmlCData[$i] : " "; + echo $this->closeTDRow(); + $this->makeTDHeader("xml","xmlComment"); + echo (!empty($this->xmlDData[$i])) ? $this->xmlDData[$i] : " "; + echo $this->closeTDRow(); + $this->makeTDHeader('xml',"xmlChildren"); + unset($this->xmlCData[$i],$this->xmlDData[$i]); + } + echo $this->closeTDRow(); + echo ''; + $this->xmlCount=0; + } + + //!xml: initiated when text between tags is encountered + function xmlCharacterData($parser,$data) { + $count=$this->xmlCount-1; + if(!empty($this->xmlCData[$count])) + $this->xmlCData[$count].=$data; + else + $this->xmlCData[$count]=$data; + } + + //!@} + + //!xml: initiated when a comment or other miscellaneous texts is encountered + function xmlDefaultHandler($parser,$data) { + //strip '' off comments + $data=str_replace(array("<!--","-->"),"",htmlspecialchars($data)); + $count=$this->xmlCount-1; + if(!empty($this->xmlDData[$count])) + $this->xmlDData[$count].=$data; + else + $this->xmlDData[$count]=$data; + } + + //! adds needed JS and CSS sources to page + static function initJSandCSS() { + echo << + /* code modified from ColdFusion's cfdump code */ + function dBug_toggleRow(source) { + var target = (document.all) ? source.parentElement.cells[1] : source.parentNode.lastChild; + dBug_toggleTarget(target,dBug_toggleSource(source)); + } + + function dBug_toggleSource(source) { + if (source.style.fontStyle=='italic') { + source.style.fontStyle='normal'; + source.title='click to collapse'; + return 'open'; + } else { + source.style.fontStyle='italic'; + source.title='click to expand'; + return 'closed'; + } + } + + function dBug_toggleTarget(target,switchToState) { + target.style.display = (switchToState=='open') ? '' : 'none'; + } + + function dBug_toggleTable(source) { + var switchToState=dBug_toggleSource(source); + if(document.all) { + var table=source.parentElement.parentElement; + for(var i=1;i + + +SCRIPTS; + } +} \ No newline at end of file From 62df2b9155f8821b7bfa1a7b5fb292dad82cc64a Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Wed, 30 Apr 2014 18:39:08 +0400 Subject: [PATCH 18/26] added namespaces fixed string rendering (added support for unicode strings) And other minor fixes PS droped compatibility with php 4 --- .php_cs | 1 - README.md | 5 +- composer.json | 4 +- dBug.php | 495 +++++++++++++++++++++++++++----------------------- tests.php | 49 ++--- 5 files changed, 296 insertions(+), 258 deletions(-) diff --git a/.php_cs b/.php_cs index c97a196..8b547e7 100644 --- a/.php_cs +++ b/.php_cs @@ -13,4 +13,3 @@ return Symfony\CS\Config\Config::create() ->fixers(array('-indentation','-braces','-psr0','-controls_spaces')) ->finder($finder) ; - diff --git a/README.md b/README.md index a008f40..cfac391 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,16 @@ dBug ==== - my mod of dBug A debug output library which is used to visualize different datatypes. Initially was developed by ospinto. For more info visit [http://kolanich.github.com/dBug/] +![ohloh stats](https://www.ohloh.net/p/php-dbug/widgets/project_partner_badge.gif) + ## Very very brief list of features -PHP version of ColdFusions cfdump. +Extended PHP version of ColdFusions cfdump. Outputs colored and structured tabular variable information. diff --git a/composer.json b/composer.json index 9808371..fbeaa5c 100644 --- a/composer.json +++ b/composer.json @@ -2,7 +2,7 @@ "name" : "KOLANICH/dBug", "type" : "library", "description" : "A debug output library which is used to visualize different datatypes.", - "keywords" : ["debug", "output", "table", "visualization"], + "keywords" : ["debug", "output", "table", "visualization","cfdump","ColdFusion"], "homepage" : "https://github.com/KOLANICH/dBug", "license" : "GPL-2.0", "authors" : [{ @@ -17,7 +17,7 @@ } ], "require" : { - "php" : ">=4.1.0" + "php" : ">=5.2" }, "suggest" : { "ext-Reflection" : "to show protected and private info (now is only implemented for Exceptions)" diff --git a/dBug.php b/dBug.php index 949275d..7d9e427 100755 --- a/dBug.php +++ b/dBug.php @@ -1,4 +1,4 @@ -=0; $i--) { + for ($i=count($arrBacktrace)-1; $i>=0; $i--) { $arrCurrent = $arrBacktrace[$i]; - if(array_key_exists("function", $arrCurrent) && + if(array_key_exists("function", $arrCurrent) && (in_array($arrCurrent["function"], $arrInclude) || (0 != strcasecmp($arrCurrent["function"], "dbug")))) continue; $arrFile = $arrCurrent; - + break; } - - if(isset($arrFile)) { + + if (isset($arrFile)) { $arrLines = file($arrFile["file"]); $code = $arrLines[($arrFile["line"]-1)]; - + //find call to dBug class preg_match('/\bnew dBug\s*\(\s*(.+)\s*\);/i', $code, $arrMatches); - + return isset($arrMatches[1])?$arrMatches[1]:'[multiline]'; } + return ""; } - - function initializeHeader(&$header){ - if(!$this->bInitialized) { + + public function initializeHeader(&$header) + { + if (!$this->bInitialized) { $header = $this->getVariableName() . " (" . $header . ")"; $this->bInitialized = true; } } - + /*! @name rendering functions used to make tables representing different variables */ //!@{ - + //!creates the main table header /*! @param string $type name of the style of the header cell @param string $header the text of the header cell @param integer $colspan colspan property for the header cell */ - function makeTableHeader($type,$header,$colspan=2) { + public function makeTableHeader($type,$header,$colspan=2) + { $this->initializeHeader($header); $this->renderTableHeader($type,$header,$colspan); } - + //!draws the main table header /*! @param string $type name of the style of the header cell @param string $text the text of the header cell @param integer $colspan colspan property for the header cell */ - function renderTableHeader($type,$text,$colspan=0){ + public function renderTableHeader($type,$text,$colspan=0) + { echo ''; } - + //!renders table of 2 cells in 1 row [type][value] /*! @param string $headerStyle name of the style of the header cell @@ -137,7 +143,8 @@ function renderTableHeader($type,$text,$colspan=0){ @param string $valueStyle name of the style of the value cell @param integer $colspan colspan property for the header cell */ - function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colspan=0){ + public function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colspan=0) + { if(!$valueStyle)$valueStyle=$headerStyle; $this->initializeHeader($header); echo '
bCollapsed) ? 'style="font-style:italic" ' : '').'class="dBug_'.$type.'Header" '.($colspan?'colspan='.$colspan:'').' onClick="dBug_toggleTable(this)">'.$text.'
@@ -147,38 +154,42 @@ function renderPrimitiveType($headerStyle,$header,$value,$valueStyle=null,$colsp ''; } - + //!creates the table row header /*! @param string $type name of the style of the key cell @param string $header the text of the key cell */ - function makeTDHeader($type,$header) { + public function makeTDHeader($type,$header) + { echo 'bCollapsed ? ' style="display:none"' : '').'> \n"; } //!@} - - + //!prints error - function error($type) { + public function error($type) + { $error='Error: Variable cannot be a'; // this just checks if the type starts with a vowel or "x" and displays either "a" or "an" - if(in_array(substr($type,0,1),array("a","e","i","o","u","x"))) - $error.="n"; - return ($error." ".$type." type"); + if(in_array(substr($type,0,1),array('a','e','i','o','u','x'))) + $error.='n'; + + return ($error.' '.$type.' type'); } //!check variable type andd process the value in right way - function checkType($var) { + public function checkType($var) + { $type=gettype($var); - switch($type) { + switch ($type) { case 'resource': $this->varIsResource($var); break; @@ -207,43 +218,47 @@ function checkType($var) { break; } } - + /*! @name functions for rendering different types */ //!@{ - + //!renders NULL as red-pink rectangle - function varIsNULL() { + public function varIsNULL() + { $this->makeTableHeader('false','NULL'); echo '
'.$value.'
'.$header.' '; } - + //!closes table row - function closeTDRow() { + public function closeTDRow() + { return "
'; } - + //!renders numeric types : integers and doubles - function varIsNumeric($var,$type) { + public function varIsNumeric($var,$type) + { $this->renderPrimitiveType('numeric',$type,$var); echo ''; } - + /*! renders string either as primitive type (if it is short (less than $embeddedStringMaxLength chars) and contains of one line) or line-by-line (otherwise) */ - function varIsString(&$var){ - if($var==''){ + public function varIsString(&$var) + { + if ($var=='') { $this->makeTableHeader('string','empty string'); echo ''; + return; } $length=strlen($var); $nv=htmlspecialchars($var,ENT_QUOTES | ENT_SUBSTITUTE,''); - $lines=preg_split('/\R/', $nv); + $lines=preg_split('/\R/u', $nv); $linesCount=count($lines); - if($linesCount==1 && $length<=self::$embeddedStringMaxLength){ + if ($linesCount==1 && $length<=self::$embeddedStringMaxLength) { $this->renderPrimitiveType('string','string ['.$length.']',$var); - }else{ + } else { $this->makeTableHeader('string','string ('.$length.' chars @ '.$linesCount.' lines)'); - foreach($lines as $num=>$line){ + foreach ($lines as $num=>$line) { $this->makeTDHeader('string',$num); echo ($line==''?'[empty line]':$line); $this->closeTDRow('string'); @@ -251,33 +266,34 @@ function varIsString(&$var){ } echo ""; } - + //!renders boolean variable - function varIsBoolean(&$var) { + public function varIsBoolean(&$var) + { $var?$this->renderPrimitiveType('boolean','boolean','TRUE','booleanTrue'):$this->renderPrimitiveType('boolean','boolean','FALSE','booleanFalse'); echo ''; } - - - function varIsArray(&$var) { + + public function varIsArray(&$var) + { $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); - + $this->makeTableHeader('array','array'); - if(is_array($var)) { - foreach($var as $key=>$value) { + if (is_array($var)) { + foreach ($var as $key=>$value) { $this->makeTDHeader('array',$key); - + //check for recursion - if(is_array($value)) { + if (is_array($value)) { $var_ser = serialize($value); - if(in_array($var_ser, $this->arrHistory, TRUE)){ + if (in_array($var_ser, $this->arrHistory, TRUE)) { echo '*RECURSION*'; echo $this->closeTDRow(); continue; } } - + //if(in_array(gettype($value),$this->arrType)) $this->checkType($value); /*else { @@ -286,40 +302,38 @@ function varIsArray(&$var) { }*/ echo $this->closeTDRow(); } - } - else echo ''.$this->error('array').$this->closeTDRow(); + } else echo ''.$this->error('array').$this->closeTDRow(); array_pop($this->arrHistory); echo ''; } - - - + //! checks wheither variable is object of special type (using varIs*Object), and renders it if it is generic object - function varIsObject(&$var) { + public function varIsObject(&$var) + { if($this->varIsSpecialObject($var))return 1; $var_ser = serialize($var); array_push($this->arrHistory, $var_ser); - - if(is_object($var)) { + + if (is_object($var)) { $this->makeTableHeader('object','object ( '.get_class($var).' )'); - if(method_exists($var,'__toString')){ + if (method_exists($var,'__toString')) { $str=$var->__toString(); - if($str!==null){ + if ($str!==null) { $this->makeTDHeader('string','[string representation]'); $this->varIsString($str); echo $this->closeTDRow(); } } $arrObjVars=get_object_vars($var); - foreach($arrObjVars as $key=>$value) { + foreach ($arrObjVars as $key=>$value) { //$value=(!is_object($value) && !is_array($value) && trim($value)=="") ? "[empty string]" : $value; $this->makeTDHeader('object',$key); - + //check for recursion - if(is_object($value)||is_array($value)) { + if (is_object($value)||is_array($value)) { $var_ser = serialize($value); - if(in_array($var_ser, $this->arrHistory, TRUE)) { + if (in_array($var_ser, $this->arrHistory, TRUE)) { echo (is_object($value)) ? '*RECURSION* -> $'.get_class($value) : '*RECURSION*'; echo $this->closeTDRow(); continue; @@ -332,42 +346,44 @@ function varIsObject(&$var) { echo $this->closeTDRow(); } $arrObjMethods=get_class_methods(get_class($var)); - foreach($arrObjMethods as $key=>$value) { + foreach ($arrObjMethods as $key=>$value) { $this->makeTDHeader('object',$value); echo '[function]'.$this->closeTDRow(); } - if($var instanceof \Iterator){ - foreach($var as $key=>$value) { + if ($var instanceof \Iterator) { + foreach ($var as $key=>$value) { $this->makeTDHeader('array',$key); $this->checkType($value); echo $this->closeTDRow(); } } - } - else{ + } else { $this->makeTableHeader('object','object'); echo ''.$this->error('object').$this->closeTDRow(); } array_pop($this->arrHistory); echo ''; } - - function varIsSpecialObject(&$var){ + + public function varIsSpecialObject(&$var) + { if($this->varIsDBObject($var))return 1; - if($var instanceof Exception){ + if ($var instanceof \Exception) { $this->varIsException($var); + return 1; } + return 0; } - - + //!shows info about different resources, uses customized rendering founctions when needed - function varIsResource($var) { + public function varIsResource($var) + { $this->makeTableHeader('resourceC','resource',1); echo "\n\n"; $restype=get_resource_type($var); - switch($restype) { + switch ($restype) { case 'fbsql result': case 'mssql result': case 'msql query': @@ -396,21 +412,22 @@ function varIsResource($var) { } echo $this->closeTDRow()."\n"; } - + //!@} - + /*! @name functions for rendering different resources */ //!@{ - + //!shows information about curl easy handles /*!simply iterates through handle info and displays everything which is not converted into false*/ - function varIsCurlEasyResource(&$var) { + public function varIsCurlEasyResource(&$var) + { $this->makeTableHeader('resource','curl easy handle',2); $info=curl_getinfo($var); - foreach($info as $name=>&$piece){ - if($piece){ + foreach ($info as $name=>&$piece) { + if ($piece) { $this->makeTDHeader('resource',$name); //echo $piece.$this->closeTDRow(); $this->checkType($piece); @@ -419,15 +436,16 @@ function varIsCurlEasyResource(&$var) { } unset($info); echo ''; - + } //!not implemented yet - function varIsCurlMultiResource(&$var) { - + public function varIsCurlMultiResource(&$var) + { } - + //!if variable is an image/gd resource type - function varIsGDResource(&$var) { + public function varIsGDResource(&$var) + { $this->makeTableHeader('resource','gd',2); $this->makeTDHeader('resource','Width'); $this->checkType(imagesx($var)); @@ -438,44 +456,42 @@ function varIsGDResource(&$var) { $this->makeTDHeader('resource','Colors'); $this->checkType(imageistruecolor($var)?'TrueColor (16 777 216)':imagecolorstotal($var)); echo $this->closeTDRow(); - + $this->makeTDHeader('resource','Image'); - - - + ob_start(); - imagepng($var); - $img = ob_get_clean(); - + imagepng($var); + $img = ob_get_clean(); + echo ''.$this->closeTDRow(); echo ''; } - + //!@} - - + /*! @name database results rendering functions */ //!@{ - + //!renders either PDO or SQLite3 statement objects /*!@returns 1 if the object is DB object, 0 otherwise*/ - function varIsDBObject($var) { + public function varIsDBObject($var) + { $structure=array(); $data=array(); $retres=false; - if($var instanceof SQLite3Result){ + if ($var instanceof \SQLite3Result) { //$var=clone $var; $dbtype=''; $count=$var->numColumns(); - for($i=0;$i<$count;$i++){ + for ($i=0;$i<$count;$i++) { $structure[$i]=array(); $structure[$i][0]=$var->columnName($i); $structure[$i][1]=$var->columnType($i); } $var->reset(); - while($res=$var->fetchArray(SQLITE3_NUM)){ + while ($res=$var->fetchArray(SQLITE3_NUM)) { $data[]=$res; } $var->reset(); @@ -484,11 +500,11 @@ function varIsDBObject($var) { $this->renderDBData($dbtype,$structure,$data); $retres=true; } - if($var instanceof PDOStatement){ + if ($var instanceof \PDOStatement) { //$var=clone $var; $count=$var->columnCount(); $col=null; - for($i=0;$i<$count;$i++){ + for ($i=0;$i<$count;$i++) { //$col=$var->getColumnMeta(0); $col=$var->getColumnMeta($i); $structure[$i]=array(); @@ -506,30 +522,32 @@ function varIsDBObject($var) { unset($dbtype); unset($data); unset($structure); + return $retres; } - + //!renders database data /*! @param string $objectType type of the db, it is only the name of header now @param array $structure 'header' of the table - columns names and types @param array $data rows of sql request result */ - function renderDBData(&$objectType,&$structure,&$data){ + public function renderDBData(&$objectType,&$structure,&$data) + { $this->makeTableHeader('database',$objectType,count($structure)+1); echo ' '; - foreach($structure as $field) { + foreach ($structure as $field) { echo ''.$field[0].""; } echo ''; - if(empty($data)){ + if (empty($data)) { echo '[empty result]'; }else $i=0; - foreach($data as $row) { + foreach ($data as $row) { echo "\n"; - echo ''.(++$i).''; - for($k=0;$k'.(++$i).''; + for ($k=0;$k'.$fieldrow."\n"; } @@ -537,23 +555,24 @@ function renderDBData(&$objectType,&$structure,&$data){ } echo ''; } - + //!renders database resource (fetch result) into table or ... smth else - function varIsDBResource($var,$db='mysql') { + public function varIsDBResource($var,$db='mysql') + { if($db == 'pgsql') $db = 'pg'; if($db == 'sybase-db' || $db == 'sybase-ct') $db = 'sybase'; - $arrFields = array('name','type','flags'); + $arrFields = array('name','type','flags'); $numrows=call_user_func($db.'_num_rows',$var); $numfields=call_user_func($db.'_num_fields',$var); $this->makeTableHeader('database',$db.' result',$numfields+1); echo ' '; - for($i=0;$i<$numfields;$i++) { + for ($i=0;$i<$numfields;$i++) { $field_header = ''; - for($j=0; $j'.$field_name.''; } echo ''; - for($i=0;$i<$numrows;$i++) { + for ($i=0;$i<$numrows;$i++) { $row=call_user_func($db.'_fetch_array',$var,constant(strtoupper($db).'_ASSOC')); echo "\n"; - echo ''.($i+1).''; - for($k=0;$k<$numfields;$k++) { + echo ''.($i+1).''; + for ($k=0;$k<$numfields;$k++) { $tempField=$field[$k]->name; $fieldrow=$row[($field[$k]->name)]; $fieldrow=($fieldrow=='') ? '[empty string]' : $fieldrow; @@ -582,13 +601,12 @@ function varIsDBResource($var,$db='mysql') { call_user_func($db.'_data_seek',$var,0); } //!@} - - + /*! @name other special kinds of objects rendering functionality */ //!@{ - + //!array of properties of every exception to be rendered first static $exceptionMainProps=array('message','code','file','line'); //!array of properties of Exception of not to be rendered @@ -596,26 +614,27 @@ function varIsDBResource($var,$db='mysql') { //'xdebug_message', 'trace' ); - + //!function used to render exceptions /*! Renders exceptions : at first basic fields, then custom fields. Custom private and protected fields are rendered if reflection api is available */ - function varIsException(&$var) { + public function varIsException(&$var) + { $code=$var->getCode(); $this->makeTableHeader('Exception',get_class($var).' :: '.$code); - foreach(static::$exceptionMainProps as &$pname) { + foreach (static::$exceptionMainProps as &$pname) { $this->makeTDHeader('Exception',$pname); $this->checkType($var->{'get'.ucfirst($pname)}()); echo $this->closeTDRow(); } unset($pname); echo ''; - if(extension_loaded('Reflection')){ - $refl=new ReflectionObject($var); + if (extension_loaded('Reflection')) { + $refl=new \ReflectionObject($var); $props=$refl->getProperties(ReflectionProperty::IS_PROTECTED|ReflectionProperty::IS_PRIVATE); - foreach($props as &$prop) { + foreach ($props as &$prop) { $pname=$prop->getName(); if(in_array($pname,static::$exceptionMainProps)||in_array($pname,static::$exceptionExcludedProps))continue; $this->makeTDHeader('Exception',$pname); @@ -625,76 +644,79 @@ function varIsException(&$var) { echo $this->closeTDRow(); } } - - foreach($var as $key=>&$value) { + + foreach ($var as $key=>&$value) { if($key=='xdebug_message')continue; $this->makeTDHeader('Exception',$key); $this->checkType($value); echo $this->closeTDRow(); } - + echo ''; } - + //!@} - - - + /*! @name xml rendering functions */ //!@{ - + //!if variable is an xml type //!remember, that you must force type to xml to use this - function varIsXml($var) { + public function varIsXml($var) + { $this->varIsXmlResource($var); } - + //!if variable is an xml resource type - function varIsXmlResource($var) { + public function varIsXmlResource($var) + { $xml_parser=xml_parser_create(); - xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0); - xml_set_element_handler($xml_parser,array(&$this,'xmlStartElement'),array(&$this,'xmlEndElement')); + xml_parser_set_option($xml_parser,XML_OPTION_CASE_FOLDING,0); + xml_set_element_handler($xml_parser,array(&$this,'xmlStartElement'),array(&$this,'xmlEndElement')); xml_set_character_data_handler($xml_parser,array(&$this,'xmlCharacterData')); - xml_set_default_handler($xml_parser,array(&$this,'xmlDefaultHandler')); - + xml_set_default_handler($xml_parser,array(&$this,'xmlDefaultHandler')); + $this->makeTableHeader('xml','xml document',2); $this->makeTDHeader('xml','xmlRoot'); - + //attempt to open xml file $bFile=(!($fp=@fopen($var,'r'))) ? false : true; - + //read xml file - if($bFile) { + if ($bFile) { while($data=str_replace("\n",'',fread($fp,4096))) $this->xmlParse($xml_parser,$data,feof($fp)); } //if xml is not a file, attempt to read it as a string else { - if(!is_string($var)) { + if (!is_string($var)) { echo $this->error('xml').$this->closeTDRow()."\n"; + return; } $data=$var; $this->xmlParse($xml_parser,$data,1); } - + echo $this->closeTDRow()."\n"; - + } - + //!parses xml - function xmlParse($xml_parser,$data,$bFinal) { - if (!xml_parse($xml_parser,$data,$bFinal)) { - die(sprintf("XML error: %s at line %d\n", - xml_error_string(xml_get_error_code($xml_parser)), + public function xmlParse($xml_parser,$data,$bFinal) + { + if (!xml_parse($xml_parser,$data,$bFinal)) { + throw new \Exception(sprintf("dBug XML error: %s at line %d\n", + xml_error_string(xml_get_error_code($xml_parser)), xml_get_current_line_number($xml_parser))); } } - + //!xml: inititiated when a start tag is encountered - function xmlStartElement($parser,$name,$attribs) { + public function xmlStartElement($parser,$name,$attribs) + { $this->xmlAttrib[$this->xmlCount]=$attribs; $this->xmlName[$this->xmlCount]=$name; $this->xmlSData[$this->xmlCount]='$this->makeTableHeader("xml","xml element",2);'; @@ -707,11 +729,12 @@ function xmlStartElement($parser,$name,$attribs) { $this->xmlSData[$this->xmlCount].='echo " ";'; $this->xmlSData[$this->xmlCount].='echo $this->closeTDRow();'; $this->xmlCount++; - } - + } + //!xml: initiated when an end tag is encountered - function xmlEndElement($parser,$name) { - for($i=0;$i<$this->xmlCount;$i++) { + public function xmlEndElement($parser,$name) + { + for ($i=0;$i<$this->xmlCount;$i++) { eval($this->xmlSData[$i]); $this->makeTDHeader("xml","xmlText"); echo (!empty($this->xmlCData[$i])) ? $this->xmlCData[$i] : " "; @@ -725,21 +748,23 @@ function xmlEndElement($parser,$name) { echo $this->closeTDRow(); echo ''; $this->xmlCount=0; - } - + } + //!xml: initiated when text between tags is encountered - function xmlCharacterData($parser,$data) { + public function xmlCharacterData($parser,$data) + { $count=$this->xmlCount-1; if(!empty($this->xmlCData[$count])) $this->xmlCData[$count].=$data; else $this->xmlCData[$count]=$data; - } - + } + //!@} - + //!xml: initiated when a comment or other miscellaneous texts is encountered - function xmlDefaultHandler($parser,$data) { + public function xmlDefaultHandler($parser,$data) + { //strip '' off comments $data=str_replace(array("<!--","-->"),"",htmlspecialchars($data)); $count=$this->xmlCount-1; @@ -748,59 +773,65 @@ function xmlDefaultHandler($parser,$data) { else $this->xmlDData[$count]=$data; } - + //! adds needed JS and CSS sources to page - static function initJSandCSS() { + public static function initJSandCSS() + { echo << /* code modified from ColdFusion's cfdump code */ - function dBug_toggleRow(source) { + function dBug_toggleRow(source) + { var target = (document.all) ? source.parentElement.cells[1] : source.parentNode.lastChild; dBug_toggleTarget(target,dBug_toggleSource(source)); } - - function dBug_toggleSource(source) { + + function dBug_toggleSource(source) + { if (source.style.fontStyle=='italic') { source.style.fontStyle='normal'; source.title='click to collapse'; + return 'open'; } else { source.style.fontStyle='italic'; source.title='click to expand'; + return 'closed'; } } - - function dBug_toggleTarget(target,switchToState) { + + function dBug_toggleTarget(target,switchToState) + { target.style.display = (switchToState=='open') ? '' : 'none'; } - - function dBug_toggleTable(source) { + + function dBug_toggleTable(source) + { var switchToState=dBug_toggleSource(source); - if(document.all) { + if (document.all) { var table=source.parentElement.parentElement; - for(var i=1;i - + SCRIPTS; } -} \ No newline at end of file +} diff --git a/tests.php b/tests.php index 86c6a30..e2a6284 100644 --- a/tests.php +++ b/tests.php @@ -1,5 +1,10 @@ -edible = $edible; - $this->color = $color; - } + var $edible; + var $color; + function Vegetable($edible, $color="green") { + $this->edible = $edible; + $this->color = $color; + } - function is_edible() { - return $this->edible; - } + function is_edible() { + return $this->edible; + } - function what_color() { - return $this->color; - } + function what_color() { + return $this->color; + } } new dBug(new Vegetable("spinach")); - $a=curl_init("http://github.com/"); - new dBug($a); - - class myExc extends Exception{ + $a=curl_init("https://github.com/"); + new dBug($a); + //curl_exec($a); + //new dBug($a); + + class myExc extends \Exception{ private $priv="PREVED"; protected $ololo="trololol"; public $num=0; @@ -58,12 +65,12 @@ function __construct($msg){ }; try{ throw new myExc("MedVed"); - }catch(Exception $e){ + }catch(\Exception $e){ new dBug($e); } try{ - throw new Exception("hahahahaha"); - }catch(Exception $e){ + throw new \Exception("hahahahaha"); + }catch(\Exception $e){ new dBug($e); } From 20d09b533443e973579a3ad2898df7b04c2020f6 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20Sz=C3=A9pe?= Date: Sat, 14 Mar 2015 21:27:04 +0100 Subject: [PATCH 19/26] Lowercase Date: Mon, 16 Mar 2015 11:07:25 +0100 Subject: [PATCH 20/26] Allow inheritance --- .gitignore | 2 ++ dBug.php | 4 ++-- 2 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 .gitignore mode change 100755 => 100644 dBug.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..957b255 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +composer.phar +vendor/ diff --git a/dBug.php b/dBug.php old mode 100755 new mode 100644 index 5c5db75..21a7962 --- a/dBug.php +++ b/dBug.php @@ -52,7 +52,7 @@ public function __construct($var,$forceType="",$bCollapsed=false) //include js and css scripts if (!defined('BDBUGINIT')) { define('BDBUGINIT', TRUE); - self::initJSandCSS(); + static::initJSandCSS(); } $arrAccept=array("array",'object',"xml"); //array of variable types that can be "forced" $this->bCollapsed = $bCollapsed; @@ -633,7 +633,7 @@ public function varIsException(&$var) echo ''; if (extension_loaded('Reflection')) { $refl=new \ReflectionObject($var); - $props=$refl->getProperties(ReflectionProperty::IS_PROTECTED|ReflectionProperty::IS_PRIVATE); + $props=$refl->getProperties(\ReflectionProperty::IS_PROTECTED|\ReflectionProperty::IS_PRIVATE); foreach ($props as &$prop) { $pname=$prop->getName(); if(in_array($pname,static::$exceptionMainProps)||in_array($pname,static::$exceptionExcludedProps))continue; From b382a094d39fb13f2744e3eed1e7564871f020dd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Viktor=20Sz=C3=A9pe?= Date: Mon, 16 Mar 2015 11:25:27 +0100 Subject: [PATCH 21/26] cosmetics --- tests.php | 180 ++++++++++++++++++++++++++---------------------------- 1 file changed, 88 insertions(+), 92 deletions(-) diff --git a/tests.php b/tests.php index e2a6284..c056cb6 100644 --- a/tests.php +++ b/tests.php @@ -1,100 +1,96 @@ -"1", - "second", - "third"=>array( - "inner third 1", - "inner third 2"=>25), - "fourth"=>49.36, - 'fifth'=>true, - 6=>false, - NULL, - ); - new dBug($variable); - class Vegetable { - - var $edible; - var $color; - function Vegetable($edible, $color="green") { - $this->edible = $edible; - $this->color = $color; - } - - function is_edible() { - return $this->edible; - } - - function what_color() { - return $this->color; - } - } - new dBug(new Vegetable("spinach")); - $a=curl_init("https://github.com/"); + use dBug\dBug; + $a="The quick brown fox jumps over the lazy dog\nThe five boxing wizards jump quickly.\r\nСъешь же ещё этих мягких французских булок, да выпей чаю\n"; + new dBug($a); + $a='vodka'; + new dBug($a); + $a=3; + new dBug($a); + $a=3.5; + new dBug($a); + $a=null; + new dBug($a); + $a=true; + new dBug($a); + $a=false; + new dBug($a); + $variable = array( + "first"=>"1", + "second", + "third"=>array( + "inner third 1", + "inner third 2"=>25), + "fourth"=>49.36, + 'fifth'=>true, + 6=>false, + NULL, + ); + new dBug($variable); + class Vegetable { + + var $edible; + var $color; + function Vegetable($edible, $color="green") { + $this->edible = $edible; + $this->color = $color; + } + + function is_edible() { + return $this->edible; + } + + function what_color() { + return $this->color; + } + } + new dBug(new Vegetable("spinach")); + $a=curl_init("https://github.com/"); new dBug($a); //curl_exec($a); //new dBug($a); - - class myExc extends \Exception{ - private $priv="PREVED"; - protected $ololo="trololol"; - public $num=0; - function __construct($msg){ - parent::__construct($msg); - $this->code=rand(0,100); - } - }; - try{ - throw new myExc("MedVed"); - }catch(\Exception $e){ - new dBug($e); - } - try{ - throw new \Exception("hahahahaha"); - }catch(\Exception $e){ - new dBug($e); - } - - - //drawing Sierpinsky triangle - //http://php.net/manual/en/function.imagesetpixel.php - $x = 200; - $y = 200; - $img = imagecreatetruecolor($x, $y); - - $corners[0] = array('x' => 100, 'y' => 10); - $corners[1] = array('x' => 0, 'y' => 190); - $corners[2] = array('x' => 200, 'y' => 190); - - $red = imagecolorallocate($img, 255, 0, 0); - - for ($i = 0; $i < 10000; $i++) { - imagesetpixel($img, round($x),round($y), $red); - $a = rand(0, 2); - $x = ($x + $corners[$a]['x']) / 2; - $y = ($y + $corners[$a]['y']) / 2; - } - new dBug($img); - - - -?> \ No newline at end of file + + class myExc extends \Exception{ + private $priv="PREVED"; + protected $ololo="trololol"; + public $num=0; + function __construct($msg){ + parent::__construct($msg); + $this->code=rand(0,100); + } + }; + try{ + throw new myExc("MedVed"); + }catch(\Exception $e){ + new dBug($e); + } + try{ + throw new \Exception("hahahahaha"); + }catch(\Exception $e){ + new dBug($e); + } + + + //drawing Sierpinsky triangle + //http://php.net/manual/en/function.imagesetpixel.php + $x = 200; + $y = 200; + $img = imagecreatetruecolor($x, $y); + + $corners[0] = array('x' => 100, 'y' => 10); + $corners[1] = array('x' => 0, 'y' => 190); + $corners[2] = array('x' => 200, 'y' => 190); + + $red = imagecolorallocate($img, 255, 0, 0); + + for ($i = 0; $i < 10000; $i++) { + imagesetpixel($img, round($x),round($y), $red); + $a = rand(0, 2); + $x = ($x + $corners[$a]['x']) / 2; + $y = ($y + $corners[$a]['y']) / 2; + } + new dBug($img); From df5f54c528c2b2fac52e9d638e5b9ad2627465bb Mon Sep 17 00:00:00 2001 From: KOLANICH Date: Mon, 16 Mar 2015 23:19:47 +0300 Subject: [PATCH 22/26] style fix with PHP-CS-Fixer +fixes in tests + composer.json + doxyfile + Readme.md --- README.md | 4 +- composer.json | 2 +- dBug.doxyfile | 2696 +++++++++++++++++++++++++++++-------------------- dBug.php | 171 ++-- tests.php | 40 +- 5 files changed, 1732 insertions(+), 1181 deletions(-) diff --git a/README.md b/README.md index cfac391..4e0306d 100644 --- a/README.md +++ b/README.md @@ -4,9 +4,9 @@ my mod of dBug A debug output library which is used to visualize different datatypes. Initially was developed by ospinto. -For more info visit [http://kolanich.github.com/dBug/] +For more info visit [https://kolanich.github.com/dBug/] -![ohloh stats](https://www.ohloh.net/p/php-dbug/widgets/project_partner_badge.gif) +[![openhub stats](https://openhub.net/p/php-dbug/widgets/project_partner_badge.gif)](https://openhub.net/p/php-dbug) ## Very very brief list of features diff --git a/composer.json b/composer.json index fbeaa5c..24e10fb 100644 --- a/composer.json +++ b/composer.json @@ -17,7 +17,7 @@ } ], "require" : { - "php" : ">=5.2" + "php" : ">=5.3" }, "suggest" : { "ext-Reflection" : "to show protected and private info (now is only implemented for Exceptions)" diff --git a/dBug.doxyfile b/dBug.doxyfile index dc4e7e9..50ee74c 100644 --- a/dBug.doxyfile +++ b/dBug.doxyfile @@ -1,358 +1,399 @@ -# Doxyfile 1.8.2 +# Doxyfile 1.8.8 # This file describes the settings to be used by the documentation system -# doxygen (www.doxygen.org) for a project +# doxygen (www.doxygen.org) for a project. # -# All text after a hash (#) is considered a comment and will be ignored +# All text after a double hash (##) is considered a comment and is placed in +# front of the TAG it is preceding. +# +# All text after a single hash (#) is considered a comment and will be ignored. # The format is: -# TAG = value [value, ...] -# For lists items can also be appended using: -# TAG += value [value, ...] -# Values that contain spaces should be placed between quotes (" ") +# TAG = value [value, ...] +# For lists, items can also be appended using: +# TAG += value [value, ...] +# Values that contain spaces should be placed between quotes (\" \"). #--------------------------------------------------------------------------- # Project related configuration options #--------------------------------------------------------------------------- -# This tag specifies the encoding used for all characters in the config file -# that follow. The default is UTF-8 which is also the encoding used for all -# text before the first occurrence of this tag. Doxygen uses libiconv (or the -# iconv built into libc) for the transcoding. See -# http://www.gnu.org/software/libiconv for the list of possible encodings. +# This tag specifies the encoding used for all characters in the config file +# that follow. The default is UTF-8 which is also the encoding used for all text +# before the first occurrence of this tag. Doxygen uses libiconv (or the iconv +# built into libc) for the transcoding. See http://www.gnu.org/software/libiconv +# for the list of possible encodings. +# The default value is: UTF-8. DOXYFILE_ENCODING = UTF-8 -# The PROJECT_NAME tag is a single word (or sequence of words) that should -# identify the project. Note that if you do not use Doxywizard you need -# to put quotes around the project name if it contains spaces. +# The PROJECT_NAME tag is a single word (or a sequence of words surrounded by +# double-quotes, unless you are using Doxywizard) that should identify the +# project for which the documentation is generated. This name is used in the +# title of most generated pages and in a few other places. +# The default value is: My Project. PROJECT_NAME = dBug -# The PROJECT_NUMBER tag can be used to enter a project or revision number. -# This could be handy for archiving the generated documentation or -# if some version control system is used. +# The PROJECT_NUMBER tag can be used to enter a project or revision number. This +# could be handy for archiving the generated documentation or if some version +# control system is used. -PROJECT_NUMBER = +PROJECT_NUMBER = -# Using the PROJECT_BRIEF tag one can provide an optional one line description -# for a project that appears at the top of each page and should give viewer -# a quick idea about the purpose of the project. Keep the description short. +# Using the PROJECT_BRIEF tag one can provide an optional one line description +# for a project that appears at the top of each page and should give viewer a +# quick idea about the purpose of the project. Keep the description short. PROJECT_BRIEF = "PHP debug output library" -# With the PROJECT_LOGO tag one can specify an logo or icon that is -# included in the documentation. The maximum height of the logo should not -# exceed 55 pixels and the maximum width should not exceed 200 pixels. -# Doxygen will copy the logo to the output directory. +# With the PROJECT_LOGO tag one can specify a logo or an icon that is included +# in the documentation. The maximum height of the logo should not exceed 55 +# pixels and the maximum width should not exceed 200 pixels. Doxygen will copy +# the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = -# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) -# base path where the generated documentation will be put. -# If a relative path is entered, it will be relative to the location -# where doxygen was started. If left blank the current directory will be used. +# The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path +# into which the generated documentation will be written. If a relative path is +# entered, it will be relative to the location where doxygen was started. If +# left blank the current directory will be used. -OUTPUT_DIRECTORY = E:\public_html\modules\dBug\doxygen +OUTPUT_DIRECTORY = E:\public_html\modules\KOLANICH\dBug\doxygen -# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create -# 4096 sub-directories (in 2 levels) under the output directory of each output -# format and will distribute the generated files over these directories. -# Enabling this option can be useful when feeding doxygen a huge amount of -# source files, where putting all generated files in the same directory would -# otherwise cause performance problems for the file system. +# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- +# directories (in 2 levels) under the output directory of each output format and +# will distribute the generated files over these directories. Enabling this +# option can be useful when feeding doxygen a huge amount of source files, where +# putting all generated files in the same directory would otherwise causes +# performance problems for the file system. +# The default value is: NO. CREATE_SUBDIRS = NO -# The OUTPUT_LANGUAGE tag is used to specify the language in which all -# documentation generated by doxygen is written. Doxygen will use this -# information to generate all constant output in the proper language. -# The default language is English, other supported languages are: -# Afrikaans, Arabic, Brazilian, Catalan, Chinese, Chinese-Traditional, -# Croatian, Czech, Danish, Dutch, Esperanto, Farsi, Finnish, French, German, -# Greek, Hungarian, Italian, Japanese, Japanese-en (Japanese with English -# messages), Korean, Korean-en, Lithuanian, Norwegian, Macedonian, Persian, -# Polish, Portuguese, Romanian, Russian, Serbian, Serbian-Cyrillic, Slovak, -# Slovene, Spanish, Swedish, Ukrainian, and Vietnamese. +# If the ALLOW_UNICODE_NAMES tag is set to YES, doxygen will allow non-ASCII +# characters to appear in the names of generated files. If set to NO, non-ASCII +# characters will be escaped, for example _xE3_x81_x84 will be used for Unicode +# U+3044. +# The default value is: NO. + +ALLOW_UNICODE_NAMES = NO + +# The OUTPUT_LANGUAGE tag is used to specify the language in which all +# documentation generated by doxygen is written. Doxygen will use this +# information to generate all constant output in the proper language. +# Possible values are: Afrikaans, Arabic, Armenian, Brazilian, Catalan, Chinese, +# Chinese-Traditional, Croatian, Czech, Danish, Dutch, English (United States), +# Esperanto, Farsi (Persian), Finnish, French, German, Greek, Hungarian, +# Indonesian, Italian, Japanese, Japanese-en (Japanese with English messages), +# Korean, Korean-en (Korean with English messages), Latvian, Lithuanian, +# Macedonian, Norwegian, Persian (Farsi), Polish, Portuguese, Romanian, Russian, +# Serbian, Serbian-Cyrillic, Slovak, Slovene, Spanish, Swedish, Turkish, +# Ukrainian and Vietnamese. +# The default value is: English. OUTPUT_LANGUAGE = English -# If the BRIEF_MEMBER_DESC tag is set to YES (the default) Doxygen will -# include brief member descriptions after the members that are listed in -# the file and class documentation (similar to JavaDoc). -# Set to NO to disable this. +# If the BRIEF_MEMBER_DESC tag is set to YES, doxygen will include brief member +# descriptions after the members that are listed in the file and class +# documentation (similar to Javadoc). Set to NO to disable this. +# The default value is: YES. BRIEF_MEMBER_DESC = YES -# If the REPEAT_BRIEF tag is set to YES (the default) Doxygen will prepend -# the brief description of a member or function before the detailed description. -# Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the +# If the REPEAT_BRIEF tag is set to YES, doxygen will prepend the brief +# description of a member or function before the detailed description +# +# Note: If both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. +# The default value is: YES. REPEAT_BRIEF = YES -# This tag implements a quasi-intelligent brief description abbreviator -# that is used to form the text in various listings. Each string -# in this list, if found as the leading text of the brief description, will be -# stripped from the text and the result after processing the whole list, is -# used as the annotated text. Otherwise, the brief description is used as-is. -# If left blank, the following values are used ("$name" is automatically -# replaced with the name of the entity): "The $name class" "The $name widget" -# "The $name file" "is" "provides" "specifies" "contains" -# "represents" "a" "an" "the" +# This tag implements a quasi-intelligent brief description abbreviator that is +# used to form the text in various listings. Each string in this list, if found +# as the leading text of the brief description, will be stripped from the text +# and the result, after processing the whole list, is used as the annotated +# text. Otherwise, the brief description is used as-is. If left blank, the +# following values are used ($name is automatically replaced with the name of +# the entity):The $name class, The $name widget, The $name file, is, provides, +# specifies, contains, represents, a, an and the. -ABBREVIATE_BRIEF = +ABBREVIATE_BRIEF = -# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then -# Doxygen will generate a detailed section even if there is only a brief +# If the ALWAYS_DETAILED_SEC and REPEAT_BRIEF tags are both set to YES then +# doxygen will generate a detailed section even if there is only a brief # description. +# The default value is: NO. ALWAYS_DETAILED_SEC = NO -# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all -# inherited members of a class in the documentation of that class as if those -# members were ordinary class members. Constructors, destructors and assignment +# If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all +# inherited members of a class in the documentation of that class as if those +# members were ordinary class members. Constructors, destructors and assignment # operators of the base classes will not be shown. +# The default value is: NO. INLINE_INHERITED_MEMB = NO -# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full -# path before files name in the file list and in the header files. If set -# to NO the shortest path that makes the file name unique will be used. +# If the FULL_PATH_NAMES tag is set to YES, doxygen will prepend the full path +# before files name in the file list and in the header files. If set to NO the +# shortest path that makes the file name unique will be used +# The default value is: YES. FULL_PATH_NAMES = YES -# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag -# can be used to strip a user-defined part of the path. Stripping is -# only done if one of the specified strings matches the left-hand part of -# the path. The tag can be used to show relative paths in the file list. -# If left blank the directory from which doxygen is run is used as the -# path to strip. Note that you specify absolute paths here, but also -# relative paths, which will be relative from the directory where doxygen is -# started. +# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path. +# Stripping is only done if one of the specified strings matches the left-hand +# part of the path. The tag can be used to show relative paths in the file list. +# If left blank the directory from which doxygen is run is used as the path to +# strip. +# +# Note that you can specify absolute paths here, but also relative paths, which +# will be relative from the directory where doxygen is started. +# This tag requires that the tag FULL_PATH_NAMES is set to YES. STRIP_FROM_PATH = E:\public_html\modules\dBug -# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of -# the path mentioned in the documentation of a class, which tells -# the reader which header file to include in order to use a class. -# If left blank only the name of the header file containing the class -# definition is used. Otherwise one should specify the include paths that -# are normally passed to the compiler using the -I flag. +# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the +# path mentioned in the documentation of a class, which tells the reader which +# header file to include in order to use a class. If left blank only the name of +# the header file containing the class definition is used. Otherwise one should +# specify the list of include paths that are normally passed to the compiler +# using the -I flag. -STRIP_FROM_INC_PATH = +STRIP_FROM_INC_PATH = -# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter -# (but less readable) file names. This can be useful if your file system -# doesn't support long names like on DOS, Mac, or CD-ROM. +# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but +# less readable) file names. This can be useful is your file systems doesn't +# support long names like on DOS, Mac, or CD-ROM. +# The default value is: NO. SHORT_NAMES = YES -# If the JAVADOC_AUTOBRIEF tag is set to YES then Doxygen -# will interpret the first line (until the first dot) of a JavaDoc-style -# comment as the brief description. If set to NO, the JavaDoc -# comments will behave just like regular Qt-style comments -# (thus requiring an explicit @brief command for a brief description.) +# If the JAVADOC_AUTOBRIEF tag is set to YES then doxygen will interpret the +# first line (until the first dot) of a Javadoc-style comment as the brief +# description. If set to NO, the Javadoc-style will behave just like regular Qt- +# style comments (thus requiring an explicit @brief command for a brief +# description.) +# The default value is: NO. JAVADOC_AUTOBRIEF = YES -# If the QT_AUTOBRIEF tag is set to YES then Doxygen will -# interpret the first line (until the first dot) of a Qt-style -# comment as the brief description. If set to NO, the comments -# will behave just like regular Qt-style comments (thus requiring -# an explicit \brief command for a brief description.) +# If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first +# line (until the first dot) of a Qt-style comment as the brief description. If +# set to NO, the Qt-style will behave just like regular Qt-style comments (thus +# requiring an explicit \brief command for a brief description.) +# The default value is: NO. QT_AUTOBRIEF = YES -# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make Doxygen -# treat a multi-line C++ special comment block (i.e. a block of //! or /// -# comments) as a brief description. This used to be the default behaviour. -# The new default is to treat a multi-line C++ comment block as a detailed -# description. Set this tag to YES if you prefer the old behaviour instead. +# The MULTILINE_CPP_IS_BRIEF tag can be set to YES to make doxygen treat a +# multi-line C++ special comment block (i.e. a block of //! or /// comments) as +# a brief description. This used to be the default behavior. The new default is +# to treat a multi-line C++ comment block as a detailed description. Set this +# tag to YES if you prefer the old behavior instead. +# +# Note that setting this tag to YES also means that rational rose comments are +# not recognized any more. +# The default value is: NO. MULTILINE_CPP_IS_BRIEF = NO -# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented -# member inherits the documentation from any documented member that it -# re-implements. +# If the INHERIT_DOCS tag is set to YES then an undocumented member inherits the +# documentation from any documented member that it re-implements. +# The default value is: YES. INHERIT_DOCS = YES -# If the SEPARATE_MEMBER_PAGES tag is set to YES, then doxygen will produce -# a new page for each member. If set to NO, the documentation of a member will -# be part of the file/class/namespace that contains it. +# If the SEPARATE_MEMBER_PAGES tag is set to YES then doxygen will produce a new +# page for each member. If set to NO, the documentation of a member will be part +# of the file/class/namespace that contains it. +# The default value is: NO. SEPARATE_MEMBER_PAGES = NO -# The TAB_SIZE tag can be used to set the number of spaces in a tab. -# Doxygen uses this value to replace tabs by spaces in code fragments. +# The TAB_SIZE tag can be used to set the number of spaces in a tab. Doxygen +# uses this value to replace tabs by spaces in code fragments. +# Minimum value: 1, maximum value: 16, default value: 4. TAB_SIZE = 4 -# This tag can be used to specify a number of aliases that acts -# as commands in the documentation. An alias has the form "name=value". -# For example adding "sideeffect=\par Side Effects:\n" will allow you to -# put the command \sideeffect (or @sideeffect) in the documentation, which -# will result in a user-defined paragraph with heading "Side Effects:". -# You can put \n's in the value part of an alias to insert newlines. +# This tag can be used to specify a number of aliases that act as commands in +# the documentation. An alias has the form: +# name=value +# For example adding +# "sideeffect=@par Side Effects:\n" +# will allow you to put the command \sideeffect (or @sideeffect) in the +# documentation, which will result in a user-defined paragraph with heading +# "Side Effects:". You can put \n's in the value part of an alias to insert +# newlines. -ALIASES = +ALIASES = -# This tag can be used to specify a number of word-keyword mappings (TCL only). -# A mapping has the form "name=value". For example adding -# "class=itcl::class" will allow you to use the command class in the -# itcl::class meaning. +# This tag can be used to specify a number of word-keyword mappings (TCL only). +# A mapping has the form "name=value". For example adding "class=itcl::class" +# will allow you to use the command class in the itcl::class meaning. -TCL_SUBST = +TCL_SUBST = -# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C -# sources only. Doxygen will then generate output that is more tailored for C. -# For instance, some of the names that are used will be different. The list -# of all members will be omitted, etc. +# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources +# only. Doxygen will then generate output that is more tailored for C. For +# instance, some of the names that are used will be different. The list of all +# members will be omitted, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_FOR_C = YES -# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java -# sources only. Doxygen will then generate output that is more tailored for -# Java. For instance, namespaces will be presented as packages, qualified -# scopes will look different, etc. +# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or +# Python sources only. Doxygen will then generate output that is more tailored +# for that language. For instance, namespaces will be presented as packages, +# qualified scopes will look different, etc. +# The default value is: NO. OPTIMIZE_OUTPUT_JAVA = NO -# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran -# sources only. Doxygen will then generate output that is more tailored for -# Fortran. +# Set the OPTIMIZE_FOR_FORTRAN tag to YES if your project consists of Fortran +# sources. Doxygen will then generate output that is tailored for Fortran. +# The default value is: NO. OPTIMIZE_FOR_FORTRAN = NO -# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL -# sources. Doxygen will then generate output that is tailored for -# VHDL. +# Set the OPTIMIZE_OUTPUT_VHDL tag to YES if your project consists of VHDL +# sources. Doxygen will then generate output that is tailored for VHDL. +# The default value is: NO. OPTIMIZE_OUTPUT_VHDL = NO -# Doxygen selects the parser to use depending on the extension of the files it -# parses. With this tag you can assign which parser to use for a given -# extension. Doxygen has a built-in mapping, but you can override or extend it -# using this tag. The format is ext=language, where ext is a file extension, -# and language is one of the parsers supported by doxygen: IDL, Java, -# Javascript, CSharp, C, C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, -# C++. For instance to make doxygen treat .inc files as Fortran files (default -# is PHP), and .f files as C (default is Fortran), use: inc=Fortran f=C. Note -# that for custom extensions you also need to set FILE_PATTERNS otherwise the -# files are not read by doxygen. - -EXTENSION_MAPPING = - -# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all -# comments according to the Markdown format, which allows for more readable -# documentation. See http://daringfireball.net/projects/markdown/ for details. -# The output of markdown processing is further processed by doxygen, so you -# can mix doxygen, HTML, and XML commands with Markdown formatting. -# Disable only in case of backward compatibilities issues. +# Doxygen selects the parser to use depending on the extension of the files it +# parses. With this tag you can assign which parser to use for a given +# extension. Doxygen has a built-in mapping, but you can override or extend it +# using this tag. The format is ext=language, where ext is a file extension, and +# language is one of the parsers supported by doxygen: IDL, Java, Javascript, +# C#, C, C++, D, PHP, Objective-C, Python, Fortran (fixed format Fortran: +# FortranFixed, free formatted Fortran: FortranFree, unknown formatted Fortran: +# Fortran. In the later case the parser tries to guess whether the code is fixed +# or free formatted code, this is the default for Fortran type files), VHDL. For +# instance to make doxygen treat .inc files as Fortran files (default is PHP), +# and .f files as C (default is Fortran), use: inc=Fortran f=C. +# +# Note: For files without extension you can use no_extension as a placeholder. +# +# Note that for custom extensions you also need to set FILE_PATTERNS otherwise +# the files are not read by doxygen. + +EXTENSION_MAPPING = + +# If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments +# according to the Markdown format, which allows for more readable +# documentation. See http://daringfireball.net/projects/markdown/ for details. +# The output of markdown processing is further processed by doxygen, so you can +# mix doxygen, HTML, and XML commands with Markdown formatting. Disable only in +# case of backward compatibilities issues. +# The default value is: YES. MARKDOWN_SUPPORT = YES -# When enabled doxygen tries to link words that correspond to documented classes, -# or namespaces to their corresponding documentation. Such a link can be -# prevented in individual cases by by putting a % sign in front of the word or +# When enabled doxygen tries to link words that correspond to documented +# classes, or namespaces to their corresponding documentation. Such a link can +# be prevented in individual cases by putting a % sign in front of the word or # globally by setting AUTOLINK_SUPPORT to NO. +# The default value is: YES. AUTOLINK_SUPPORT = YES -# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want -# to include (a tag file for) the STL sources as input, then you should -# set this tag to YES in order to let doxygen match functions declarations and -# definitions whose arguments contain STL classes (e.g. func(std::string); v.s. -# func(std::string) {}). This also makes the inheritance and collaboration +# If you use STL classes (i.e. std::string, std::vector, etc.) but do not want +# to include (a tag file for) the STL sources as input, then you should set this +# tag to YES in order to let doxygen match functions declarations and +# definitions whose arguments contain STL classes (e.g. func(std::string); +# versus func(std::string) {}). This also make the inheritance and collaboration # diagrams that involve STL classes more complete and accurate. +# The default value is: NO. BUILTIN_STL_SUPPORT = YES -# If you use Microsoft's C++/CLI language, you should set this option to YES to +# If you use Microsoft's C++/CLI language, you should set this option to YES to # enable parsing support. +# The default value is: NO. CPP_CLI_SUPPORT = NO -# Set the SIP_SUPPORT tag to YES if your project consists of sip sources only. -# Doxygen will parse them like normal C++ but will assume all classes use public -# instead of private inheritance when no explicit protection keyword is present. +# Set the SIP_SUPPORT tag to YES if your project consists of sip (see: +# http://www.riverbankcomputing.co.uk/software/sip/intro) sources only. Doxygen +# will parse them like normal C++ but will assume all classes use public instead +# of private inheritance when no explicit protection keyword is present. +# The default value is: NO. SIP_SUPPORT = NO # For Microsoft's IDL there are propget and propput attributes to indicate -# getter and setter methods for a property. Setting this option to YES (the -# default) will make doxygen replace the get and set methods by a property in -# the documentation. This will only work if the methods are indeed getting or -# setting a simple type. If this is not the case, or you want to show the -# methods anyway, you should set this option to NO. +# getter and setter methods for a property. Setting this option to YES will make +# doxygen to replace the get and set methods by a property in the documentation. +# This will only work if the methods are indeed getting or setting a simple +# type. If this is not the case, or you want to show the methods anyway, you +# should set this option to NO. +# The default value is: YES. IDL_PROPERTY_SUPPORT = YES -# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC -# tag is set to YES, then doxygen will reuse the documentation of the first -# member in the group (if any) for the other members of the group. By default +# If member grouping is used in the documentation and the DISTRIBUTE_GROUP_DOC +# tag is set to YES then doxygen will reuse the documentation of the first +# member in the group (if any) for the other members of the group. By default # all members of a group must be documented explicitly. +# The default value is: NO. DISTRIBUTE_GROUP_DOC = NO -# Set the SUBGROUPING tag to YES (the default) to allow class member groups of -# the same type (for instance a group of public functions) to be put as a -# subgroup of that type (e.g. under the Public Functions section). Set it to -# NO to prevent subgrouping. Alternatively, this can be done per class using -# the \nosubgrouping command. +# Set the SUBGROUPING tag to YES to allow class member groups of the same type +# (for instance a group of public functions) to be put as a subgroup of that +# type (e.g. under the Public Functions section). Set it to NO to prevent +# subgrouping. Alternatively, this can be done per class using the +# \nosubgrouping command. +# The default value is: YES. SUBGROUPING = YES -# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and -# unions are shown inside the group in which they are included (e.g. using -# @ingroup) instead of on a separate page (for HTML and Man pages) or -# section (for LaTeX and RTF). +# When the INLINE_GROUPED_CLASSES tag is set to YES, classes, structs and unions +# are shown inside the group in which they are included (e.g. using \ingroup) +# instead of on a separate page (for HTML and Man pages) or section (for LaTeX +# and RTF). +# +# Note that this feature does not work in combination with +# SEPARATE_MEMBER_PAGES. +# The default value is: NO. INLINE_GROUPED_CLASSES = NO -# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and -# unions with only public data fields will be shown inline in the documentation -# of the scope in which they are defined (i.e. file, namespace, or group -# documentation), provided this scope is documented. If set to NO (the default), -# structs, classes, and unions are shown on a separate page (for HTML and Man -# pages) or section (for LaTeX and RTF). +# When the INLINE_SIMPLE_STRUCTS tag is set to YES, structs, classes, and unions +# with only public data fields or simple typedef fields will be shown inline in +# the documentation of the scope in which they are defined (i.e. file, +# namespace, or group documentation), provided this scope is documented. If set +# to NO, structs, classes, and unions are shown on a separate page (for HTML and +# Man pages) or section (for LaTeX and RTF). +# The default value is: NO. INLINE_SIMPLE_STRUCTS = NO -# When TYPEDEF_HIDES_STRUCT is enabled, a typedef of a struct, union, or enum -# is documented as struct, union, or enum with the name of the typedef. So -# typedef struct TypeS {} TypeT, will appear in the documentation as a struct -# with name TypeT. When disabled the typedef will appear as a member of a file, -# namespace, or class. And the struct will be named TypeS. This can typically -# be useful for C code in case the coding convention dictates that all compound +# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or +# enum is documented as struct, union, or enum with the name of the typedef. So +# typedef struct TypeS {} TypeT, will appear in the documentation as a struct +# with name TypeT. When disabled the typedef will appear as a member of a file, +# namespace, or class. And the struct will be named TypeS. This can typically be +# useful for C code in case the coding convention dictates that all compound # types are typedef'ed and only the typedef is referenced, never the tag name. +# The default value is: NO. TYPEDEF_HIDES_STRUCT = NO -# The SYMBOL_CACHE_SIZE determines the size of the internal cache use to -# determine which symbols to keep in memory and which to flush to disk. -# When the cache is full, less often used symbols will be written to disk. -# For small to medium size projects (<1000 input files) the default value is -# probably good enough. For larger projects a too small cache size can cause -# doxygen to be busy swapping symbols to and from disk most of the time -# causing a significant performance penalty. -# If the system has enough physical memory increasing the cache will improve the -# performance by keeping more symbols in memory. Note that the value works on -# a logarithmic scale so increasing the size by one will roughly double the -# memory usage. The cache size is given by this formula: -# 2^(16+SYMBOL_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. - -SYMBOL_CACHE_SIZE = 0 - -# Similar to the SYMBOL_CACHE_SIZE the size of the symbol lookup cache can be -# set using LOOKUP_CACHE_SIZE. This cache is used to resolve symbols given -# their name and scope. Since this can be an expensive process and often the -# same symbol appear multiple times in the code, doxygen keeps a cache of -# pre-resolved symbols. If the cache is too small doxygen will become slower. -# If the cache is too large, memory is wasted. The cache size is given by this -# formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range is 0..9, the default is 0, -# corresponding to a cache size of 2^16 = 65536 symbols. +# The size of the symbol lookup cache can be set using LOOKUP_CACHE_SIZE. This +# cache is used to resolve symbols given their name and scope. Since this can be +# an expensive process and often the same symbol appears multiple times in the +# code, doxygen keeps a cache of pre-resolved symbols. If the cache is too small +# doxygen will become slower. If the cache is too large, memory is wasted. The +# cache size is given by this formula: 2^(16+LOOKUP_CACHE_SIZE). The valid range +# is 0..9, the default is 0, corresponding to a cache size of 2^16=65536 +# symbols. At the end of a run doxygen will report the cache usage and suggest +# the optimal cache size from a speed point of view. +# Minimum value: 0, maximum value: 9, default value: 0. LOOKUP_CACHE_SIZE = 0 @@ -360,1221 +401,1634 @@ LOOKUP_CACHE_SIZE = 0 # Build related configuration options #--------------------------------------------------------------------------- -# If the EXTRACT_ALL tag is set to YES doxygen will assume all entities in -# documentation are documented, even if no documentation was available. -# Private class members and static file members will be hidden unless -# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES +# If the EXTRACT_ALL tag is set to YES, doxygen will assume all entities in +# documentation are documented, even if no documentation was available. Private +# class members and static file members will be hidden unless the +# EXTRACT_PRIVATE respectively EXTRACT_STATIC tags are set to YES. +# Note: This will also disable the warnings about undocumented members that are +# normally produced when WARNINGS is set to YES. +# The default value is: NO. EXTRACT_ALL = YES -# If the EXTRACT_PRIVATE tag is set to YES all private members of a class -# will be included in the documentation. +# If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will +# be included in the documentation. +# The default value is: NO. EXTRACT_PRIVATE = YES -# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal +# If the EXTRACT_PACKAGE tag is set to YES, all members with package or internal # scope will be included in the documentation. +# The default value is: NO. EXTRACT_PACKAGE = YES -# If the EXTRACT_STATIC tag is set to YES all static members of a file -# will be included in the documentation. +# If the EXTRACT_STATIC tag is set to YES, all static members of a file will be +# included in the documentation. +# The default value is: NO. EXTRACT_STATIC = YES -# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs) -# defined locally in source files will be included in the documentation. -# If set to NO only classes defined in header files are included. +# If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined +# locally in source files will be included in the documentation. If set to NO, +# only classes defined in header files are included. Does not have any effect +# for Java sources. +# The default value is: YES. EXTRACT_LOCAL_CLASSES = YES -# This flag is only useful for Objective-C code. When set to YES local -# methods, which are defined in the implementation section but not in -# the interface are included in the documentation. -# If set to NO (the default) only methods in the interface are included. +# This flag is only useful for Objective-C code. If set to YES, local methods, +# which are defined in the implementation section but not in the interface are +# included in the documentation. If set to NO, only methods in the interface are +# included. +# The default value is: NO. EXTRACT_LOCAL_METHODS = YES -# If this flag is set to YES, the members of anonymous namespaces will be -# extracted and appear in the documentation as a namespace called -# 'anonymous_namespace{file}', where file will be replaced with the base -# name of the file that contains the anonymous namespace. By default -# anonymous namespaces are hidden. +# If this flag is set to YES, the members of anonymous namespaces will be +# extracted and appear in the documentation as a namespace called +# 'anonymous_namespace{file}', where file will be replaced with the base name of +# the file that contains the anonymous namespace. By default anonymous namespace +# are hidden. +# The default value is: NO. EXTRACT_ANON_NSPACES = NO -# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all -# undocumented members of documented classes, files or namespaces. -# If set to NO (the default) these members will be included in the -# various overviews, but no documentation section is generated. -# This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_MEMBERS tag is set to YES, doxygen will hide all +# undocumented members inside documented classes or files. If set to NO these +# members will be included in the various overviews, but no documentation +# section is generated. This option has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_MEMBERS = NO -# If the HIDE_UNDOC_CLASSES tag is set to YES, Doxygen will hide all -# undocumented classes that are normally visible in the class hierarchy. -# If set to NO (the default) these classes will be included in the various -# overviews. This option has no effect if EXTRACT_ALL is enabled. +# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all +# undocumented classes that are normally visible in the class hierarchy. If set +# to NO, these classes will be included in the various overviews. This option +# has no effect if EXTRACT_ALL is enabled. +# The default value is: NO. HIDE_UNDOC_CLASSES = NO -# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, Doxygen will hide all -# friend (class|struct|union) declarations. -# If set to NO (the default) these declarations will be included in the -# documentation. +# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend +# (class|struct|union) declarations. If set to NO, these declarations will be +# included in the documentation. +# The default value is: NO. HIDE_FRIEND_COMPOUNDS = NO -# If the HIDE_IN_BODY_DOCS tag is set to YES, Doxygen will hide any -# documentation blocks found inside the body of a function. -# If set to NO (the default) these blocks will be appended to the -# function's detailed documentation block. +# If the HIDE_IN_BODY_DOCS tag is set to YES, doxygen will hide any +# documentation blocks found inside the body of a function. If set to NO, these +# blocks will be appended to the function's detailed documentation block. +# The default value is: NO. HIDE_IN_BODY_DOCS = NO -# The INTERNAL_DOCS tag determines if documentation -# that is typed after a \internal command is included. If the tag is set -# to NO (the default) then the documentation will be excluded. -# Set it to YES to include the internal documentation. +# The INTERNAL_DOCS tag determines if documentation that is typed after a +# \internal command is included. If the tag is set to NO then the documentation +# will be excluded. Set it to YES to include the internal documentation. +# The default value is: NO. INTERNAL_DOCS = YES -# If the CASE_SENSE_NAMES tag is set to NO then Doxygen will only generate -# file names in lower-case letters. If set to YES upper-case letters are also -# allowed. This is useful if you have classes or files whose names only differ -# in case and if your file system supports case sensitive file names. Windows +# If the CASE_SENSE_NAMES tag is set to NO then doxygen will only generate file +# names in lower-case letters. If set to YES, upper-case letters are also +# allowed. This is useful if you have classes or files whose names only differ +# in case and if your file system supports case sensitive file names. Windows # and Mac users are advised to set this option to NO. +# The default value is: system dependent. CASE_SENSE_NAMES = NO -# If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen -# will show members with their full class and namespace scopes in the -# documentation. If set to YES the scope will be hidden. +# If the HIDE_SCOPE_NAMES tag is set to NO then doxygen will show members with +# their full class and namespace scopes in the documentation. If set to YES, the +# scope will be hidden. +# The default value is: NO. HIDE_SCOPE_NAMES = YES -# If the SHOW_INCLUDE_FILES tag is set to YES (the default) then Doxygen -# will put a list of the files that are included by a file in the documentation -# of that file. +# If the HIDE_COMPOUND_REFERENCE tag is set to NO (default) then doxygen will +# append additional text to a page's title, such as Class Reference. If set to +# YES the compound reference will be hidden. +# The default value is: NO. + +HIDE_COMPOUND_REFERENCE= NO + +# If the SHOW_INCLUDE_FILES tag is set to YES then doxygen will put a list of +# the files that are included by a file in the documentation of that file. +# The default value is: YES. SHOW_INCLUDE_FILES = YES -# If the FORCE_LOCAL_INCLUDES tag is set to YES then Doxygen -# will list include files with double quotes in the documentation -# rather than with sharp brackets. +# If the SHOW_GROUPED_MEMB_INC tag is set to YES then Doxygen will add for each +# grouped member an include statement to the documentation, telling the reader +# which file to include in order to use the member. +# The default value is: NO. + +SHOW_GROUPED_MEMB_INC = NO + +# If the FORCE_LOCAL_INCLUDES tag is set to YES then doxygen will list include +# files with double quotes in the documentation rather than with sharp brackets. +# The default value is: NO. FORCE_LOCAL_INCLUDES = NO -# If the INLINE_INFO tag is set to YES (the default) then a tag [inline] -# is inserted in the documentation for inline members. +# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the +# documentation for inline members. +# The default value is: YES. INLINE_INFO = YES -# If the SORT_MEMBER_DOCS tag is set to YES (the default) then doxygen -# will sort the (detailed) documentation of file and class members -# alphabetically by member name. If set to NO the members will appear in -# declaration order. +# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the +# (detailed) documentation of file and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. +# The default value is: YES. SORT_MEMBER_DOCS = YES -# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the -# brief documentation of file, namespace and class members alphabetically -# by member name. If set to NO (the default) the members will appear in -# declaration order. +# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief +# descriptions of file, namespace and class members alphabetically by member +# name. If set to NO, the members will appear in declaration order. Note that +# this will also influence the order of the classes in the class list. +# The default value is: NO. SORT_BRIEF_DOCS = NO -# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen -# will sort the (brief and detailed) documentation of class members so that -# constructors and destructors are listed first. If set to NO (the default) -# the constructors will appear in the respective orders defined by -# SORT_MEMBER_DOCS and SORT_BRIEF_DOCS. -# This tag will be ignored for brief docs if SORT_BRIEF_DOCS is set to NO -# and ignored for detailed docs if SORT_MEMBER_DOCS is set to NO. +# If the SORT_MEMBERS_CTORS_1ST tag is set to YES then doxygen will sort the +# (brief and detailed) documentation of class members so that constructors and +# destructors are listed first. If set to NO the constructors will appear in the +# respective orders defined by SORT_BRIEF_DOCS and SORT_MEMBER_DOCS. +# Note: If SORT_BRIEF_DOCS is set to NO this option is ignored for sorting brief +# member documentation. +# Note: If SORT_MEMBER_DOCS is set to NO this option is ignored for sorting +# detailed member documentation. +# The default value is: NO. SORT_MEMBERS_CTORS_1ST = YES -# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the -# hierarchy of group names into alphabetical order. If set to NO (the default) -# the group names will appear in their defined order. +# If the SORT_GROUP_NAMES tag is set to YES then doxygen will sort the hierarchy +# of group names into alphabetical order. If set to NO the group names will +# appear in their defined order. +# The default value is: NO. SORT_GROUP_NAMES = YES -# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be -# sorted by fully-qualified names, including namespaces. If set to -# NO (the default), the class list will be sorted only by class name, -# not including the namespace part. -# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. -# Note: This option applies only to the class list, not to the -# alphabetical list. +# If the SORT_BY_SCOPE_NAME tag is set to YES, the class list will be sorted by +# fully-qualified names, including namespaces. If set to NO, the class list will +# be sorted only by class name, not including the namespace part. +# Note: This option is not very useful if HIDE_SCOPE_NAMES is set to YES. +# Note: This option applies only to the class list, not to the alphabetical +# list. +# The default value is: NO. SORT_BY_SCOPE_NAME = NO -# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to -# do proper type resolution of all parameters of a function it will reject a -# match between the prototype and the implementation of a member function even -# if there is only one candidate or it is obvious which candidate to choose -# by doing a simple string match. By disabling STRICT_PROTO_MATCHING doxygen -# will still accept a match between prototype and implementation in such cases. +# If the STRICT_PROTO_MATCHING option is enabled and doxygen fails to do proper +# type resolution of all parameters of a function it will reject a match between +# the prototype and the implementation of a member function even if there is +# only one candidate or it is obvious which candidate to choose by doing a +# simple string match. By disabling STRICT_PROTO_MATCHING doxygen will still +# accept a match between prototype and implementation in such cases. +# The default value is: NO. STRICT_PROTO_MATCHING = NO -# The GENERATE_TODOLIST tag can be used to enable (YES) or -# disable (NO) the todo list. This list is created by putting \todo -# commands in the documentation. +# The GENERATE_TODOLIST tag can be used to enable (YES) or disable (NO) the todo +# list. This list is created by putting \todo commands in the documentation. +# The default value is: YES. GENERATE_TODOLIST = YES -# The GENERATE_TESTLIST tag can be used to enable (YES) or -# disable (NO) the test list. This list is created by putting \test -# commands in the documentation. +# The GENERATE_TESTLIST tag can be used to enable (YES) or disable (NO) the test +# list. This list is created by putting \test commands in the documentation. +# The default value is: YES. GENERATE_TESTLIST = YES -# The GENERATE_BUGLIST tag can be used to enable (YES) or -# disable (NO) the bug list. This list is created by putting \bug -# commands in the documentation. +# The GENERATE_BUGLIST tag can be used to enable (YES) or disable (NO) the bug +# list. This list is created by putting \bug commands in the documentation. +# The default value is: YES. GENERATE_BUGLIST = YES -# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or -# disable (NO) the deprecated list. This list is created by putting -# \deprecated commands in the documentation. +# The GENERATE_DEPRECATEDLIST tag can be used to enable (YES) or disable (NO) +# the deprecated list. This list is created by putting \deprecated commands in +# the documentation. +# The default value is: YES. GENERATE_DEPRECATEDLIST= YES -# The ENABLED_SECTIONS tag can be used to enable conditional -# documentation sections, marked by \if sectionname ... \endif. +# The ENABLED_SECTIONS tag can be used to enable conditional documentation +# sections, marked by \if ... \endif and \cond +# ... \endcond blocks. -ENABLED_SECTIONS = +ENABLED_SECTIONS = -# The MAX_INITIALIZER_LINES tag determines the maximum number of lines -# the initial value of a variable or macro consists of for it to appear in -# the documentation. If the initializer consists of more lines than specified -# here it will be hidden. Use a value of 0 to hide initializers completely. -# The appearance of the initializer of individual variables and macros in the -# documentation can be controlled using \showinitializer or \hideinitializer -# command in the documentation regardless of this setting. +# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the +# initial value of a variable or macro / define can have for it to appear in the +# documentation. If the initializer consists of more lines than specified here +# it will be hidden. Use a value of 0 to hide initializers completely. The +# appearance of the value of individual variables and macros / defines can be +# controlled using \showinitializer or \hideinitializer command in the +# documentation regardless of this setting. +# Minimum value: 0, maximum value: 10000, default value: 30. MAX_INITIALIZER_LINES = 30 -# Set the SHOW_USED_FILES tag to NO to disable the list of files generated -# at the bottom of the documentation of classes and structs. If set to YES the +# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at +# the bottom of the documentation of classes and structs. If set to YES, the # list will mention the files that were used to generate the documentation. +# The default value is: YES. SHOW_USED_FILES = YES -# Set the SHOW_FILES tag to NO to disable the generation of the Files page. -# This will remove the Files entry from the Quick Index and from the -# Folder Tree View (if specified). The default is YES. +# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This +# will remove the Files entry from the Quick Index and from the Folder Tree View +# (if specified). +# The default value is: YES. SHOW_FILES = YES -# Set the SHOW_NAMESPACES tag to NO to disable the generation of the -# Namespaces page. This will remove the Namespaces entry from the Quick Index -# and from the Folder Tree View (if specified). The default is YES. +# Set the SHOW_NAMESPACES tag to NO to disable the generation of the Namespaces +# page. This will remove the Namespaces entry from the Quick Index and from the +# Folder Tree View (if specified). +# The default value is: YES. SHOW_NAMESPACES = YES -# The FILE_VERSION_FILTER tag can be used to specify a program or script that -# doxygen should invoke to get the current version for each file (typically from -# the version control system). Doxygen will invoke the program by executing (via -# popen()) the command , where is the value of -# the FILE_VERSION_FILTER tag, and is the name of an input file -# provided by doxygen. Whatever the program writes to standard output -# is used as the file version. See the manual for examples. - -FILE_VERSION_FILTER = - -# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed -# by doxygen. The layout file controls the global structure of the generated -# output files in an output format independent way. To create the layout file -# that represents doxygen's defaults, run doxygen with the -l option. -# You can optionally specify a file name after the option, if omitted -# DoxygenLayout.xml will be used as the name of the layout file. +# The FILE_VERSION_FILTER tag can be used to specify a program or script that +# doxygen should invoke to get the current version for each file (typically from +# the version control system). Doxygen will invoke the program by executing (via +# popen()) the command command input-file, where command is the value of the +# FILE_VERSION_FILTER tag, and input-file is the name of an input file provided +# by doxygen. Whatever the program writes to standard output is used as the file +# version. For an example see the documentation. + +FILE_VERSION_FILTER = + +# The LAYOUT_FILE tag can be used to specify a layout file which will be parsed +# by doxygen. The layout file controls the global structure of the generated +# output files in an output format independent way. To create the layout file +# that represents doxygen's defaults, run doxygen with the -l option. You can +# optionally specify a file name after the option, if omitted DoxygenLayout.xml +# will be used as the name of the layout file. +# +# Note that if you run doxygen from a directory containing a file called +# DoxygenLayout.xml, doxygen will parse it automatically even if the LAYOUT_FILE +# tag is left empty. -LAYOUT_FILE = +LAYOUT_FILE = -# The CITE_BIB_FILES tag can be used to specify one or more bib files -# containing the references data. This must be a list of .bib files. The -# .bib extension is automatically appended if omitted. Using this command -# requires the bibtex tool to be installed. See also -# http://en.wikipedia.org/wiki/BibTeX for more info. For LaTeX the style -# of the bibliography can be controlled using LATEX_BIB_STYLE. To use this -# feature you need bibtex and perl available in the search path. +# The CITE_BIB_FILES tag can be used to specify one or more bib files containing +# the reference definitions. This must be a list of .bib files. The .bib +# extension is automatically appended if omitted. This requires the bibtex tool +# to be installed. See also http://en.wikipedia.org/wiki/BibTeX for more info. +# For LaTeX the style of the bibliography can be controlled using +# LATEX_BIB_STYLE. To use this feature you need bibtex and perl available in the +# search path. See also \cite for info how to create references. -CITE_BIB_FILES = +CITE_BIB_FILES = #--------------------------------------------------------------------------- -# configuration options related to warning and progress messages +# Configuration options related to warning and progress messages #--------------------------------------------------------------------------- -# The QUIET tag can be used to turn on/off the messages that are generated -# by doxygen. Possible values are YES and NO. If left blank NO is used. +# The QUIET tag can be used to turn on/off the messages that are generated to +# standard output by doxygen. If QUIET is set to YES this implies that the +# messages are off. +# The default value is: NO. QUIET = NO -# The WARNINGS tag can be used to turn on/off the warning messages that are -# generated by doxygen. Possible values are YES and NO. If left blank -# NO is used. +# The WARNINGS tag can be used to turn on/off the warning messages that are +# generated to standard error (stderr) by doxygen. If WARNINGS is set to YES +# this implies that the warnings are on. +# +# Tip: Turn warnings on while writing the documentation. +# The default value is: YES. WARNINGS = YES -# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings -# for undocumented members. If EXTRACT_ALL is set to YES then this flag will -# automatically be disabled. +# If the WARN_IF_UNDOCUMENTED tag is set to YES then doxygen will generate +# warnings for undocumented members. If EXTRACT_ALL is set to YES then this flag +# will automatically be disabled. +# The default value is: YES. WARN_IF_UNDOCUMENTED = NO -# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for -# potential errors in the documentation, such as not documenting some -# parameters in a documented function, or documenting parameters that -# don't exist or using markup commands wrongly. +# If the WARN_IF_DOC_ERROR tag is set to YES, doxygen will generate warnings for +# potential errors in the documentation, such as not documenting some parameters +# in a documented function, or documenting parameters that don't exist or using +# markup commands wrongly. +# The default value is: YES. WARN_IF_DOC_ERROR = YES -# The WARN_NO_PARAMDOC option can be enabled to get warnings for -# functions that are documented, but have no documentation for their parameters -# or return value. If set to NO (the default) doxygen will only warn about -# wrong or incomplete parameter documentation, but not about the absence of -# documentation. +# This WARN_NO_PARAMDOC option can be enabled to get warnings for functions that +# are documented, but have no documentation for their parameters or return +# value. If set to NO, doxygen will only warn about wrong or incomplete +# parameter documentation, but not about the absence of documentation. +# The default value is: NO. WARN_NO_PARAMDOC = NO -# The WARN_FORMAT tag determines the format of the warning messages that -# doxygen can produce. The string should contain the $file, $line, and $text -# tags, which will be replaced by the file and line number from which the -# warning originated and the warning text. Optionally the format may contain -# $version, which will be replaced by the version of the file (if it could -# be obtained via FILE_VERSION_FILTER) +# The WARN_FORMAT tag determines the format of the warning messages that doxygen +# can produce. The string should contain the $file, $line, and $text tags, which +# will be replaced by the file and line number from which the warning originated +# and the warning text. Optionally the format may contain $version, which will +# be replaced by the version of the file (if it could be obtained via +# FILE_VERSION_FILTER) +# The default value is: $file:$line: $text. WARN_FORMAT = "$file:$line: $text" -# The WARN_LOGFILE tag can be used to specify a file to which warning -# and error messages should be written. If left blank the output is written -# to stderr. +# The WARN_LOGFILE tag can be used to specify a file to which warning and error +# messages should be written. If left blank the output is written to standard +# error (stderr). -WARN_LOGFILE = +WARN_LOGFILE = #--------------------------------------------------------------------------- -# configuration options related to the input files +# Configuration options related to the input files #--------------------------------------------------------------------------- -# The INPUT tag can be used to specify the files and/or directories that contain -# documented source files. You may enter file names like "myfile.cpp" or -# directories like "/usr/src/myproject". Separate the files or directories -# with spaces. +# The INPUT tag is used to specify the files and/or directories that contain +# documented source files. You may enter file names like myfile.cpp or +# directories like /usr/src/myproject. Separate the files or directories with +# spaces. +# Note: If this tag is empty the current directory is searched. -INPUT = E:\public_html\modules\dBug\dBug.php +INPUT = E:\public_html\modules\KOLANICH\dBug\dBug.php -# This tag can be used to specify the character encoding of the source files -# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is -# also the default input encoding. Doxygen uses libiconv (or the iconv built -# into libc) for the transcoding. See http://www.gnu.org/software/libiconv for -# the list of possible encodings. +# This tag can be used to specify the character encoding of the source files +# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses +# libiconv (or the iconv built into libc) for the transcoding. See the libiconv +# documentation (see: http://www.gnu.org/software/libiconv) for the list of +# possible encodings. +# The default value is: UTF-8. INPUT_ENCODING = UTF-8 -# If the value of the INPUT tag contains directories, you can use the -# FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank the following patterns are tested: -# *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh -# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py -# *.f90 *.f *.for *.vhd *.vhdl +# If the value of the INPUT tag contains directories, you can use the +# FILE_PATTERNS tag to specify one or more wildcard patterns (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank the +# following patterns are tested:*.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, +# *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, +# *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, +# *.md, *.mm, *.dox, *.py, *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, +# *.qsf, *.as and *.js. FILE_PATTERNS = *.php -# The RECURSIVE tag can be used to turn specify whether or not subdirectories -# should be searched for input files as well. Possible values are YES and NO. -# If left blank NO is used. +# The RECURSIVE tag can be used to specify whether or not subdirectories should +# be searched for input files as well. +# The default value is: NO. RECURSIVE = YES -# The EXCLUDE tag can be used to specify files and/or directories that should be -# excluded from the INPUT source files. This way you can easily exclude a -# subdirectory from a directory tree whose root is specified with the INPUT tag. -# Note that relative paths are relative to the directory from which doxygen is +# The EXCLUDE tag can be used to specify files and/or directories that should be +# excluded from the INPUT source files. This way you can easily exclude a +# subdirectory from a directory tree whose root is specified with the INPUT tag. +# +# Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = +EXCLUDE = -# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or -# directories that are symbolic links (a Unix file system feature) are excluded +# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or +# directories that are symbolic links (a Unix file system feature) are excluded # from the input. +# The default value is: NO. EXCLUDE_SYMLINKS = NO -# If the value of the INPUT tag contains directories, you can use the -# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude -# certain files from those directories. Note that the wildcards are matched -# against the file with absolute path, so to exclude all test directories -# for example use the pattern */test/* +# If the value of the INPUT tag contains directories, you can use the +# EXCLUDE_PATTERNS tag to specify one or more wildcard patterns to exclude +# certain files from those directories. +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories for example use the pattern */test/* EXCLUDE_PATTERNS = */.*/* -# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names -# (namespaces, classes, functions, etc.) that should be excluded from the -# output. The symbol name can be a fully qualified name, a word, or if the -# wildcard * is used, a substring. Examples: ANamespace, AClass, +# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names +# (namespaces, classes, functions, etc.) that should be excluded from the +# output. The symbol name can be a fully qualified name, a word, or if the +# wildcard * is used, a substring. Examples: ANamespace, AClass, # AClass::ANamespace, ANamespace::*Test +# +# Note that the wildcards are matched against the file with absolute path, so to +# exclude all test directories use the pattern */test/* -EXCLUDE_SYMBOLS = +EXCLUDE_SYMBOLS = -# The EXAMPLE_PATH tag can be used to specify one or more files or -# directories that contain example code fragments that are included (see -# the \include command). +# The EXAMPLE_PATH tag can be used to specify one or more files or directories +# that contain example code fragments that are included (see the \include +# command). EXAMPLE_PATH = E:\public_html\modules\dBug\tests.php -# If the value of the EXAMPLE_PATH tag contains directories, you can use the -# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp -# and *.h) to filter out the source-files in the directories. If left -# blank all files are included. +# If the value of the EXAMPLE_PATH tag contains directories, you can use the +# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and +# *.h) to filter out the source-files in the directories. If left blank all +# files are included. -EXAMPLE_PATTERNS = +EXAMPLE_PATTERNS = -# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be -# searched for input files to be used with the \include or \dontinclude -# commands irrespective of the value of the RECURSIVE tag. -# Possible values are YES and NO. If left blank NO is used. +# If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be +# searched for input files to be used with the \include or \dontinclude commands +# irrespective of the value of the RECURSIVE tag. +# The default value is: NO. EXAMPLE_RECURSIVE = YES -# The IMAGE_PATH tag can be used to specify one or more files or -# directories that contain image that are included in the documentation (see -# the \image command). +# The IMAGE_PATH tag can be used to specify one or more files or directories +# that contain images that are to be included in the documentation (see the +# \image command). -IMAGE_PATH = +IMAGE_PATH = -# The INPUT_FILTER tag can be used to specify a program that doxygen should -# invoke to filter for each input file. Doxygen will invoke the filter program -# by executing (via popen()) the command , where -# is the value of the INPUT_FILTER tag, and is the name of an -# input file. Doxygen will then use the output that the filter program writes -# to standard output. If FILTER_PATTERNS is specified, this tag will be -# ignored. +# The INPUT_FILTER tag can be used to specify a program that doxygen should +# invoke to filter for each input file. Doxygen will invoke the filter program +# by executing (via popen()) the command: +# +# +# +# where is the value of the INPUT_FILTER tag, and is the +# name of an input file. Doxygen will then use the output that the filter +# program writes to standard output. If FILTER_PATTERNS is specified, this tag +# will be ignored. +# +# Note that the filter must not add or remove lines; it is applied before the +# code is scanned, but not when the output code is generated. If lines are added +# or removed, the anchors will not be placed correctly. -INPUT_FILTER = +INPUT_FILTER = -# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern -# basis. Doxygen will compare the file name with each pattern and apply the -# filter if there is a match. The filters are a list of the form: -# pattern=filter (like *.cpp=my_cpp_filter). See INPUT_FILTER for further -# info on how filters are used. If FILTER_PATTERNS is empty or if -# non of the patterns match the file name, INPUT_FILTER is applied. +# The FILTER_PATTERNS tag can be used to specify filters on a per file pattern +# basis. Doxygen will compare the file name with each pattern and apply the +# filter if there is a match. The filters are a list of the form: pattern=filter +# (like *.cpp=my_cpp_filter). See INPUT_FILTER for further information on how +# filters are used. If the FILTER_PATTERNS tag is empty or if none of the +# patterns match the file name, INPUT_FILTER is applied. -FILTER_PATTERNS = +FILTER_PATTERNS = -# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using -# INPUT_FILTER) will be used to filter the input files when producing source -# files to browse (i.e. when SOURCE_BROWSER is set to YES). +# If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using +# INPUT_FILTER) will also be used to filter the input files that are used for +# producing the source files to browse (i.e. when SOURCE_BROWSER is set to YES). +# The default value is: NO. FILTER_SOURCE_FILES = NO -# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file -# pattern. A pattern will override the setting for FILTER_PATTERN (if any) -# and it is also possible to disable source filtering for a specific pattern -# using *.ext= (so without naming a filter). This option only has effect when -# FILTER_SOURCE_FILES is enabled. +# The FILTER_SOURCE_PATTERNS tag can be used to specify source filters per file +# pattern. A pattern will override the setting for FILTER_PATTERN (if any) and +# it is also possible to disable source filtering for a specific pattern using +# *.ext= (so without naming a filter). +# This tag requires that the tag FILTER_SOURCE_FILES is set to YES. + +FILTER_SOURCE_PATTERNS = -FILTER_SOURCE_PATTERNS = +# If the USE_MDFILE_AS_MAINPAGE tag refers to the name of a markdown file that +# is part of the input, its contents will be placed on the main page +# (index.html). This can be useful if you have a project on for instance GitHub +# and want to reuse the introduction page also for the doxygen output. + +USE_MDFILE_AS_MAINPAGE = #--------------------------------------------------------------------------- -# configuration options related to source browsing +# Configuration options related to source browsing #--------------------------------------------------------------------------- -# If the SOURCE_BROWSER tag is set to YES then a list of source files will -# be generated. Documented entities will be cross-referenced with these sources. -# Note: To get rid of all source code in the generated output, make sure also -# VERBATIM_HEADERS is set to NO. +# If the SOURCE_BROWSER tag is set to YES then a list of source files will be +# generated. Documented entities will be cross-referenced with these sources. +# +# Note: To get rid of all source code in the generated output, make sure that +# also VERBATIM_HEADERS is set to NO. +# The default value is: NO. SOURCE_BROWSER = YES -# Setting the INLINE_SOURCES tag to YES will include the body -# of functions and classes directly in the documentation. +# Setting the INLINE_SOURCES tag to YES will include the body of functions, +# classes and enums directly into the documentation. +# The default value is: NO. INLINE_SOURCES = NO -# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct -# doxygen to hide any special comment blocks from generated source code -# fragments. Normal C, C++ and Fortran comments will always remain visible. +# Setting the STRIP_CODE_COMMENTS tag to YES will instruct doxygen to hide any +# special comment blocks from generated source code fragments. Normal C, C++ and +# Fortran comments will always remain visible. +# The default value is: YES. STRIP_CODE_COMMENTS = YES -# If the REFERENCED_BY_RELATION tag is set to YES -# then for each documented function all documented -# functions referencing it will be listed. +# If the REFERENCED_BY_RELATION tag is set to YES then for each documented +# function all documented functions referencing it will be listed. +# The default value is: NO. REFERENCED_BY_RELATION = YES -# If the REFERENCES_RELATION tag is set to YES -# then for each documented function all documented entities -# called/used by that function will be listed. +# If the REFERENCES_RELATION tag is set to YES then for each documented function +# all documented entities called/used by that function will be listed. +# The default value is: NO. REFERENCES_RELATION = YES -# If the REFERENCES_LINK_SOURCE tag is set to YES (the default) -# and SOURCE_BROWSER tag is set to YES, then the hyperlinks from -# functions in REFERENCES_RELATION and REFERENCED_BY_RELATION lists will -# link to the source code. Otherwise they will link to the documentation. +# If the REFERENCES_LINK_SOURCE tag is set to YES and SOURCE_BROWSER tag is set +# to YES then the hyperlinks from functions in REFERENCES_RELATION and +# REFERENCED_BY_RELATION lists will link to the source code. Otherwise they will +# link to the documentation. +# The default value is: YES. REFERENCES_LINK_SOURCE = YES -# If the USE_HTAGS tag is set to YES then the references to source code -# will point to the HTML generated by the htags(1) tool instead of doxygen -# built-in source browser. The htags tool is part of GNU's global source -# tagging system (see http://www.gnu.org/software/global/global.html). You -# will need version 4.8.6 or higher. +# If SOURCE_TOOLTIPS is enabled (the default) then hovering a hyperlink in the +# source code will show a tooltip with additional information such as prototype, +# brief description and links to the definition and documentation. Since this +# will make the HTML file larger and loading of large files a bit slower, you +# can opt to disable this feature. +# The default value is: YES. +# This tag requires that the tag SOURCE_BROWSER is set to YES. + +SOURCE_TOOLTIPS = YES + +# If the USE_HTAGS tag is set to YES then the references to source code will +# point to the HTML generated by the htags(1) tool instead of doxygen built-in +# source browser. The htags tool is part of GNU's global source tagging system +# (see http://www.gnu.org/software/global/global.html). You will need version +# 4.8.6 or higher. +# +# To use it do the following: +# - Install the latest version of global +# - Enable SOURCE_BROWSER and USE_HTAGS in the config file +# - Make sure the INPUT points to the root of the source tree +# - Run doxygen as normal +# +# Doxygen will invoke htags (and that will in turn invoke gtags), so these +# tools must be available from the command line (i.e. in the search path). +# +# The result: instead of the source browser generated by doxygen, the links to +# source code will now point to the output of htags. +# The default value is: NO. +# This tag requires that the tag SOURCE_BROWSER is set to YES. USE_HTAGS = NO -# If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen -# will generate a verbatim copy of the header file for each class for -# which an include is specified. Set to NO to disable this. +# If the VERBATIM_HEADERS tag is set the YES then doxygen will generate a +# verbatim copy of the header file for each class for which an include is +# specified. Set to NO to disable this. +# See also: Section \class. +# The default value is: YES. VERBATIM_HEADERS = YES #--------------------------------------------------------------------------- -# configuration options related to the alphabetical class index +# Configuration options related to the alphabetical class index #--------------------------------------------------------------------------- -# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index -# of all compounds will be generated. Enable this if the project -# contains a lot of classes, structs, unions or interfaces. +# If the ALPHABETICAL_INDEX tag is set to YES, an alphabetical index of all +# compounds will be generated. Enable this if the project contains a lot of +# classes, structs, unions or interfaces. +# The default value is: YES. ALPHABETICAL_INDEX = YES -# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then -# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns -# in which this list will be split (can be a number in the range [1..20]) +# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in +# which the alphabetical index list will be split. +# Minimum value: 1, maximum value: 20, default value: 5. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. COLS_IN_ALPHA_INDEX = 5 -# In case all classes in a project start with a common prefix, all -# classes will be put under the same header in the alphabetical index. -# The IGNORE_PREFIX tag can be used to specify one or more prefixes that -# should be ignored while generating the index headers. +# In case all classes in a project start with a common prefix, all classes will +# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag +# can be used to specify a prefix (or a list of prefixes) that should be ignored +# while generating the index headers. +# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. -IGNORE_PREFIX = +IGNORE_PREFIX = #--------------------------------------------------------------------------- -# configuration options related to the HTML output +# Configuration options related to the HTML output #--------------------------------------------------------------------------- -# If the GENERATE_HTML tag is set to YES (the default) Doxygen will -# generate HTML output. +# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output +# The default value is: YES. GENERATE_HTML = YES -# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. -# If a relative path is entered the value of OUTPUT_DIRECTORY will be -# put in front of it. If left blank `html' will be used as the default path. +# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a +# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of +# it. +# The default directory is: html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_OUTPUT = html -# The HTML_FILE_EXTENSION tag can be used to specify the file extension for -# each generated HTML page (for example: .htm,.php,.asp). If it is left blank -# doxygen will generate files with .html extension. +# The HTML_FILE_EXTENSION tag can be used to specify the file extension for each +# generated HTML page (for example: .htm, .php, .asp). +# The default value is: .html. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_FILE_EXTENSION = .html -# The HTML_HEADER tag can be used to specify a personal HTML header for -# each generated HTML page. If it is left blank doxygen will generate a -# standard header. Note that when using a custom header you are responsible -# for the proper inclusion of any scripts and style sheets that doxygen -# needs, which is dependent on the configuration options used. -# It is advised to generate a default header using "doxygen -w html -# header.html footer.html stylesheet.css YourConfigFile" and then modify -# that header. Note that the header is subject to change so you typically -# have to redo this when upgrading to a newer version of doxygen or when -# changing the value of configuration settings such as GENERATE_TREEVIEW! - -HTML_HEADER = - -# The HTML_FOOTER tag can be used to specify a personal HTML footer for -# each generated HTML page. If it is left blank doxygen will generate a -# standard footer. - -HTML_FOOTER = - -# The HTML_STYLESHEET tag can be used to specify a user-defined cascading -# style sheet that is used by each HTML page. It can be used to -# fine-tune the look of the HTML output. If left blank doxygen will -# generate a default style sheet. Note that it is recommended to use -# HTML_EXTRA_STYLESHEET instead of this one, as it is more robust and this -# tag will in the future become obsolete. - -HTML_STYLESHEET = - -# The HTML_EXTRA_STYLESHEET tag can be used to specify an additional -# user-defined cascading style sheet that is included after the standard -# style sheets created by doxygen. Using this option one can overrule -# certain style aspects. This is preferred over using HTML_STYLESHEET -# since it does not replace the standard style sheet and is therefor more -# robust against future updates. Doxygen will copy the style sheet file to -# the output directory. - -HTML_EXTRA_STYLESHEET = - -# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or -# other source files which should be copied to the HTML output directory. Note -# that these files will be copied to the base HTML output directory. Use the -# $relpath$ marker in the HTML_HEADER and/or HTML_FOOTER files to load these -# files. In the HTML_STYLESHEET file, use the file name only. Also note that -# the files will be copied as-is; there are no commands or markers available. - -HTML_EXTRA_FILES = - -# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. -# Doxygen will adjust the colors in the style sheet and background images -# according to this color. Hue is specified as an angle on a colorwheel, -# see http://en.wikipedia.org/wiki/Hue for more information. -# For instance the value 0 represents red, 60 is yellow, 120 is green, -# 180 is cyan, 240 is blue, 300 purple, and 360 is red again. -# The allowed range is 0 to 359. +# The HTML_HEADER tag can be used to specify a user-defined HTML header file for +# each generated HTML page. If the tag is left blank doxygen will generate a +# standard header. +# +# To get valid HTML the header file that includes any scripts and style sheets +# that doxygen needs, which is dependent on the configuration options used (e.g. +# the setting GENERATE_TREEVIEW). It is highly recommended to start with a +# default header using +# doxygen -w html new_header.html new_footer.html new_stylesheet.css +# YourConfigFile +# and then modify the file new_header.html. See also section "Doxygen usage" +# for information on how to generate the default header that doxygen normally +# uses. +# Note: The header is subject to change so you typically have to regenerate the +# default header when upgrading to a newer version of doxygen. For a description +# of the possible markers and block names see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_HEADER = + +# The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each +# generated HTML page. If the tag is left blank doxygen will generate a standard +# footer. See HTML_HEADER for more information on how to generate a default +# footer and what special commands can be used inside the footer. See also +# section "Doxygen usage" for information on how to generate the default footer +# that doxygen normally uses. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_FOOTER = + +# The HTML_STYLESHEET tag can be used to specify a user-defined cascading style +# sheet that is used by each HTML page. It can be used to fine-tune the look of +# the HTML output. If left blank doxygen will generate a default style sheet. +# See also section "Doxygen usage" for information on how to generate the style +# sheet that doxygen normally uses. +# Note: It is recommended to use HTML_EXTRA_STYLESHEET instead of this tag, as +# it is more robust and this tag (HTML_STYLESHEET) will in the future become +# obsolete. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_STYLESHEET = + +# The HTML_EXTRA_STYLESHEET tag can be used to specify additional user-defined +# cascading style sheets that are included after the standard style sheets +# created by doxygen. Using this option one can overrule certain style aspects. +# This is preferred over using HTML_STYLESHEET since it does not replace the +# standard style sheet and is therefore more robust against future updates. +# Doxygen will copy the style sheet files to the output directory. +# Note: The order of the extra stylesheet files is of importance (e.g. the last +# stylesheet in the list overrules the setting of the previous ones in the +# list). For an example see the documentation. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_STYLESHEET = + +# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or +# other source files which should be copied to the HTML output directory. Note +# that these files will be copied to the base HTML output directory. Use the +# $relpath^ marker in the HTML_HEADER and/or HTML_FOOTER files to load these +# files. In the HTML_STYLESHEET file, use the file name only. Also note that the +# files will be copied as-is; there are no commands or markers available. +# This tag requires that the tag GENERATE_HTML is set to YES. + +HTML_EXTRA_FILES = + +# The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen +# will adjust the colors in the stylesheet and background images according to +# this color. Hue is specified as an angle on a colorwheel, see +# http://en.wikipedia.org/wiki/Hue for more information. For instance the value +# 0 represents red, 60 is yellow, 120 is green, 180 is cyan, 240 is blue, 300 +# purple, and 360 is red again. +# Minimum value: 0, maximum value: 359, default value: 220. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_HUE = 220 -# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of -# the colors in the HTML output. For a value of 0 the output will use -# grayscales only. A value of 255 will produce the most vivid colors. +# The HTML_COLORSTYLE_SAT tag controls the purity (or saturation) of the colors +# in the HTML output. For a value of 0 the output will use grayscales only. A +# value of 255 will produce the most vivid colors. +# Minimum value: 0, maximum value: 255, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_SAT = 100 -# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to -# the luminance component of the colors in the HTML output. Values below -# 100 gradually make the output lighter, whereas values above 100 make -# the output darker. The value divided by 100 is the actual gamma applied, -# so 80 represents a gamma of 0.8, The value 220 represents a gamma of 2.2, -# and 100 does not change the gamma. +# The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to the +# luminance component of the colors in the HTML output. Values below 100 +# gradually make the output lighter, whereas values above 100 make the output +# darker. The value divided by 100 is the actual gamma applied, so 80 represents +# a gamma of 0.8, The value 220 represents a gamma of 2.2, and 100 does not +# change the gamma. +# Minimum value: 40, maximum value: 240, default value: 80. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_COLORSTYLE_GAMMA = 80 -# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML -# page will contain the date and time when the page was generated. Setting -# this to NO can help when comparing the output of multiple runs. +# If the HTML_TIMESTAMP tag is set to YES then the footer of each generated HTML +# page will contain the date and time when the page was generated. Setting this +# to NO can help when comparing the output of multiple runs. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_TIMESTAMP = YES -# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML -# documentation will contain sections that can be hidden and shown after the +# If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML +# documentation will contain sections that can be hidden and shown after the # page has loaded. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_DYNAMIC_SECTIONS = YES -# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of -# entries shown in the various tree structured indices initially; the user -# can expand and collapse entries dynamically later on. Doxygen will expand -# the tree to such a level that at most the specified number of entries are -# visible (unless a fully collapsed tree already exceeds this amount). -# So setting the number of entries 1 will produce a full collapsed tree by -# default. 0 is a special value representing an infinite number of entries -# and will result in a full expanded tree by default. +# With HTML_INDEX_NUM_ENTRIES one can control the preferred number of entries +# shown in the various tree structured indices initially; the user can expand +# and collapse entries dynamically later on. Doxygen will expand the tree to +# such a level that at most the specified number of entries are visible (unless +# a fully collapsed tree already exceeds this amount). So setting the number of +# entries 1 will produce a full collapsed tree by default. 0 is a special value +# representing an infinite number of entries and will result in a full expanded +# tree by default. +# Minimum value: 0, maximum value: 9999, default value: 100. +# This tag requires that the tag GENERATE_HTML is set to YES. HTML_INDEX_NUM_ENTRIES = 100 -# If the GENERATE_DOCSET tag is set to YES, additional index files -# will be generated that can be used as input for Apple's Xcode 3 -# integrated development environment, introduced with OSX 10.5 (Leopard). -# To create a documentation set, doxygen will generate a Makefile in the -# HTML output directory. Running make will produce the docset in that -# directory and running "make install" will install the docset in -# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find -# it at startup. -# See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html +# If the GENERATE_DOCSET tag is set to YES, additional index files will be +# generated that can be used as input for Apple's Xcode 3 integrated development +# environment (see: http://developer.apple.com/tools/xcode/), introduced with +# OSX 10.5 (Leopard). To create a documentation set, doxygen will generate a +# Makefile in the HTML output directory. Running make will produce the docset in +# that directory and running make install will install the docset in +# ~/Library/Developer/Shared/Documentation/DocSets so that Xcode will find it at +# startup. See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html # for more information. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_DOCSET = NO -# When GENERATE_DOCSET tag is set to YES, this tag determines the name of the -# feed. A documentation feed provides an umbrella under which multiple -# documentation sets from a single provider (such as a company or product suite) -# can be grouped. +# This tag determines the name of the docset feed. A documentation feed provides +# an umbrella under which multiple documentation sets from a single provider +# (such as a company or product suite) can be grouped. +# The default value is: Doxygen generated docs. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_FEEDNAME = "Doxygen generated docs" -# When GENERATE_DOCSET tag is set to YES, this tag specifies a string that -# should uniquely identify the documentation set bundle. This should be a -# reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen -# will append .docset to the name. +# This tag specifies a string that should uniquely identify the documentation +# set bundle. This should be a reverse domain-name style string, e.g. +# com.mycompany.MyDocSet. Doxygen will append .docset to the name. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_BUNDLE_ID = org.doxygen.Project -# When GENERATE_PUBLISHER_ID tag specifies a string that should uniquely -# identify the documentation publisher. This should be a reverse domain-name -# style string, e.g. com.mycompany.MyDocSet.documentation. +# The DOCSET_PUBLISHER_ID tag specifies a string that should uniquely identify +# the documentation publisher. This should be a reverse domain-name style +# string, e.g. com.mycompany.MyDocSet.documentation. +# The default value is: org.doxygen.Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_ID = org.doxygen.Publisher -# The GENERATE_PUBLISHER_NAME tag identifies the documentation publisher. +# The DOCSET_PUBLISHER_NAME tag identifies the documentation publisher. +# The default value is: Publisher. +# This tag requires that the tag GENERATE_DOCSET is set to YES. DOCSET_PUBLISHER_NAME = Publisher -# If the GENERATE_HTMLHELP tag is set to YES, additional index files -# will be generated that can be used as input for tools like the -# Microsoft HTML help workshop to generate a compiled HTML help file (.chm) -# of the generated HTML documentation. +# If the GENERATE_HTMLHELP tag is set to YES then doxygen generates three +# additional HTML index files: index.hhp, index.hhc, and index.hhk. The +# index.hhp is a project file that can be read by Microsoft's HTML Help Workshop +# (see: http://www.microsoft.com/en-us/download/details.aspx?id=21138) on +# Windows. +# +# The HTML Help Workshop contains a compiler that can convert all HTML output +# generated by doxygen into a single compiled HTML file (.chm). Compiled HTML +# files are now used as the Windows 98 help format, and will replace the old +# Windows help format (.hlp) on all Windows platforms in the future. Compressed +# HTML files also contain an index, a table of contents, and you can search for +# words in the documentation. The HTML workshop also contains a viewer for +# compressed HTML files. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_HTMLHELP = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_FILE tag can -# be used to specify the file name of the resulting .chm file. You -# can add a path in front of the file if the result should not be +# The CHM_FILE tag can be used to specify the file name of the resulting .chm +# file. You can add a path in front of the file if the result should not be # written to the html output directory. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_FILE = +CHM_FILE = -# If the GENERATE_HTMLHELP tag is set to YES, the HHC_LOCATION tag can -# be used to specify the location (absolute path including file name) of -# the HTML help compiler (hhc.exe). If non-empty doxygen will try to run -# the HTML help compiler on the generated index.hhp. +# The HHC_LOCATION tag can be used to specify the location (absolute path +# including file name) of the HTML help compiler (hhc.exe). If non-empty, +# doxygen will try to run the HTML help compiler on the generated index.hhp. +# The file has to be specified with full path. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -HHC_LOCATION = +HHC_LOCATION = -# If the GENERATE_HTMLHELP tag is set to YES, the GENERATE_CHI flag -# controls if a separate .chi index file is generated (YES) or that -# it should be included in the master .chm file (NO). +# The GENERATE_CHI flag controls if a separate .chi index file is generated +# (YES) or that it should be included in the master .chm file (NO). +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. GENERATE_CHI = NO -# If the GENERATE_HTMLHELP tag is set to YES, the CHM_INDEX_ENCODING -# is used to encode HtmlHelp index (hhk), content (hhc) and project file -# content. +# The CHM_INDEX_ENCODING is used to encode HtmlHelp index (hhk), content (hhc) +# and project file content. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. -CHM_INDEX_ENCODING = +CHM_INDEX_ENCODING = -# If the GENERATE_HTMLHELP tag is set to YES, the BINARY_TOC flag -# controls whether a binary table of contents is generated (YES) or a -# normal table of contents (NO) in the .chm file. +# The BINARY_TOC flag controls whether a binary table of contents is generated +# (YES) or a normal table of contents (NO) in the .chm file. Furthermore it +# enables the Previous and Next buttons. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. BINARY_TOC = NO -# The TOC_EXPAND flag can be set to YES to add extra items for group members -# to the contents of the HTML help documentation and to the tree view. +# The TOC_EXPAND flag can be set to YES to add extra items for group members to +# the table of contents of the HTML help documentation and to the tree view. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTMLHELP is set to YES. TOC_EXPAND = NO -# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and -# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated -# that can be used as input for Qt's qhelpgenerator to generate a -# Qt Compressed Help (.qch) of the generated HTML documentation. +# If the GENERATE_QHP tag is set to YES and both QHP_NAMESPACE and +# QHP_VIRTUAL_FOLDER are set, an additional index file will be generated that +# can be used as input for Qt's qhelpgenerator to generate a Qt Compressed Help +# (.qch) of the generated HTML documentation. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_QHP = NO -# If the QHG_LOCATION tag is specified, the QCH_FILE tag can -# be used to specify the file name of the resulting .qch file. -# The path specified is relative to the HTML output folder. +# If the QHG_LOCATION tag is specified, the QCH_FILE tag can be used to specify +# the file name of the resulting .qch file. The path specified is relative to +# the HTML output folder. +# This tag requires that the tag GENERATE_QHP is set to YES. -QCH_FILE = +QCH_FILE = -# The QHP_NAMESPACE tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#namespace +# The QHP_NAMESPACE tag specifies the namespace to use when generating Qt Help +# Project output. For more information please see Qt Help Project / Namespace +# (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#namespace). +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_NAMESPACE = org.doxygen.Project -# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating -# Qt Help Project output. For more information please see -# http://doc.trolltech.com/qthelpproject.html#virtual-folders +# The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating Qt +# Help Project output. For more information please see Qt Help Project / Virtual +# Folders (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#virtual- +# folders). +# The default value is: doc. +# This tag requires that the tag GENERATE_QHP is set to YES. QHP_VIRTUAL_FOLDER = doc -# If QHP_CUST_FILTER_NAME is set, it specifies the name of a custom filter to -# add. For more information please see -# http://doc.trolltech.com/qthelpproject.html#custom-filters +# If the QHP_CUST_FILTER_NAME tag is set, it specifies the name of a custom +# filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_NAME = -# The QHP_CUST_FILT_ATTRS tag specifies the list of the attributes of the -# custom filter to add. For more information please see -# -# Qt Help Project / Custom Filters. +# The QHP_CUST_FILTER_ATTRS tag specifies the list of the attributes of the +# custom filter to add. For more information please see Qt Help Project / Custom +# Filters (see: http://qt-project.org/doc/qt-4.8/qthelpproject.html#custom- +# filters). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_CUST_FILTER_ATTRS = +QHP_CUST_FILTER_ATTRS = -# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this -# project's -# filter section matches. -# -# Qt Help Project / Filter Attributes. +# The QHP_SECT_FILTER_ATTRS tag specifies the list of the attributes this +# project's filter section matches. Qt Help Project / Filter Attributes (see: +# http://qt-project.org/doc/qt-4.8/qthelpproject.html#filter-attributes). +# This tag requires that the tag GENERATE_QHP is set to YES. -QHP_SECT_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = -# If the GENERATE_QHP tag is set to YES, the QHG_LOCATION tag can -# be used to specify the location of Qt's qhelpgenerator. -# If non-empty doxygen will try to run qhelpgenerator on the generated -# .qhp file. +# The QHG_LOCATION tag can be used to specify the location of Qt's +# qhelpgenerator. If non-empty doxygen will try to run qhelpgenerator on the +# generated .qhp file. +# This tag requires that the tag GENERATE_QHP is set to YES. -QHG_LOCATION = +QHG_LOCATION = -# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files -# will be generated, which together with the HTML files, form an Eclipse help -# plugin. To install this plugin and make it available under the help contents -# menu in Eclipse, the contents of the directory containing the HTML and XML -# files needs to be copied into the plugins directory of eclipse. The name of -# the directory within the plugins directory should be the same as -# the ECLIPSE_DOC_ID value. After copying Eclipse needs to be restarted before -# the help appears. +# If the GENERATE_ECLIPSEHELP tag is set to YES, additional index files will be +# generated, together with the HTML files, they form an Eclipse help plugin. To +# install this plugin and make it available under the help contents menu in +# Eclipse, the contents of the directory containing the HTML and XML files needs +# to be copied into the plugins directory of eclipse. The name of the directory +# within the plugins directory should be the same as the ECLIPSE_DOC_ID value. +# After copying Eclipse needs to be restarted before the help appears. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_ECLIPSEHELP = NO -# A unique identifier for the eclipse help plugin. When installing the plugin -# the directory name containing the HTML and XML files should also have -# this name. +# A unique identifier for the Eclipse help plugin. When installing the plugin +# the directory name containing the HTML and XML files should also have this +# name. Each documentation set should have its own identifier. +# The default value is: org.doxygen.Project. +# This tag requires that the tag GENERATE_ECLIPSEHELP is set to YES. ECLIPSE_DOC_ID = org.doxygen.Project -# The DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) -# at top of each HTML page. The value NO (the default) enables the index and -# the value YES disables it. Since the tabs have the same information as the -# navigation tree you can set this option to NO if you already set -# GENERATE_TREEVIEW to YES. +# If you want full control over the layout of the generated HTML pages it might +# be necessary to disable the index and replace it with your own. The +# DISABLE_INDEX tag can be used to turn on/off the condensed index (tabs) at top +# of each HTML page. A value of NO enables the index and the value YES disables +# it. Since the tabs in the index contain the same information as the navigation +# tree, you can set this option to YES if you also set GENERATE_TREEVIEW to YES. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. DISABLE_INDEX = NO -# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index -# structure should be generated to display hierarchical information. -# If the tag value is set to YES, a side panel will be generated -# containing a tree-like index structure (just like the one that -# is generated for HTML Help). For this to work a browser that supports -# JavaScript, DHTML, CSS and frames is required (i.e. any modern browser). -# Windows users are probably better off using the HTML help feature. -# Since the tree basically has the same information as the tab index you -# could consider to set DISABLE_INDEX to NO when enabling this option. +# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index +# structure should be generated to display hierarchical information. If the tag +# value is set to YES, a side panel will be generated containing a tree-like +# index structure (just like the one that is generated for HTML Help). For this +# to work a browser that supports JavaScript, DHTML, CSS and frames is required +# (i.e. any modern browser). Windows users are probably better off using the +# HTML help feature. Via custom stylesheets (see HTML_EXTRA_STYLESHEET) one can +# further fine-tune the look of the index. As an example, the default style +# sheet generated by doxygen has an example that shows how to put an image at +# the root of the tree instead of the PROJECT_NAME. Since the tree basically has +# the same information as the tab index, you could consider setting +# DISABLE_INDEX to YES when enabling this option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. GENERATE_TREEVIEW = YES -# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values -# (range [0,1..20]) that doxygen will group on one line in the generated HTML -# documentation. Note that a value of 0 will completely suppress the enum -# values from appearing in the overview section. +# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values that +# doxygen will group on one line in the generated HTML documentation. +# +# Note that a value of 0 will completely suppress the enum values from appearing +# in the overview section. +# Minimum value: 0, maximum value: 20, default value: 4. +# This tag requires that the tag GENERATE_HTML is set to YES. ENUM_VALUES_PER_LINE = 1 -# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be -# used to set the initial width (in pixels) of the frame in which the tree -# is shown. +# If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be used +# to set the initial width (in pixels) of the frame in which the tree is shown. +# Minimum value: 0, maximum value: 1500, default value: 250. +# This tag requires that the tag GENERATE_HTML is set to YES. TREEVIEW_WIDTH = 250 -# When the EXT_LINKS_IN_WINDOW option is set to YES doxygen will open -# links to external symbols imported via tag files in a separate window. +# If the EXT_LINKS_IN_WINDOW option is set to YES, doxygen will open links to +# external symbols imported via tag files in a separate window. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. EXT_LINKS_IN_WINDOW = NO -# Use this tag to change the font size of Latex formulas included -# as images in the HTML documentation. The default is 10. Note that -# when you change the font size after a successful doxygen run you need -# to manually remove any form_*.png images from the HTML output directory -# to force them to be regenerated. +# Use this tag to change the font size of LaTeX formulas included as images in +# the HTML documentation. When you change the font size after a successful +# doxygen run you need to manually remove any form_*.png images from the HTML +# output directory to force them to be regenerated. +# Minimum value: 8, maximum value: 50, default value: 10. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_FONTSIZE = 10 -# Use the FORMULA_TRANPARENT tag to determine whether or not the images -# generated for formulas are transparent PNGs. Transparent PNGs are -# not supported properly for IE 6.0, but are supported on all modern browsers. -# Note that when changing this option you need to delete any form_*.png files -# in the HTML output before the changes have effect. +# Use the FORMULA_TRANPARENT tag to determine whether or not the images +# generated for formulas are transparent PNGs. Transparent PNGs are not +# supported properly for IE 6.0, but are supported on all modern browsers. +# +# Note that when changing this option you need to delete any form_*.png files in +# the HTML output directory before the changes have effect. +# The default value is: YES. +# This tag requires that the tag GENERATE_HTML is set to YES. FORMULA_TRANSPARENT = YES -# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax -# (see http://www.mathjax.org) which uses client side Javascript for the -# rendering instead of using prerendered bitmaps. Use this if you do not -# have LaTeX installed or if you want to formulas look prettier in the HTML -# output. When enabled you may also need to install MathJax separately and -# configure the path to it using the MATHJAX_RELPATH option. +# Enable the USE_MATHJAX option to render LaTeX formulas using MathJax (see +# http://www.mathjax.org) which uses client side Javascript for the rendering +# instead of using pre-rendered bitmaps. Use this if you do not have LaTeX +# installed or if you want to formulas look prettier in the HTML output. When +# enabled you may also need to install MathJax separately and configure the path +# to it using the MATHJAX_RELPATH option. +# The default value is: NO. +# This tag requires that the tag GENERATE_HTML is set to YES. USE_MATHJAX = NO -# When MathJax is enabled you need to specify the location relative to the -# HTML output directory using the MATHJAX_RELPATH option. The destination -# directory should contain the MathJax.js script. For instance, if the mathjax -# directory is located at the same level as the HTML output directory, then -# MATHJAX_RELPATH should be ../mathjax. The default value points to -# the MathJax Content Delivery Network so you can quickly see the result without -# installing MathJax. However, it is strongly recommended to install a local -# copy of MathJax from http://www.mathjax.org before deployment. +# When MathJax is enabled you can set the default output format to be used for +# the MathJax output. See the MathJax site (see: +# http://docs.mathjax.org/en/latest/output.html) for more details. +# Possible values are: HTML-CSS (which is slower, but has the best +# compatibility), NativeMML (i.e. MathML) and SVG. +# The default value is: HTML-CSS. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_FORMAT = HTML-CSS + +# When MathJax is enabled you need to specify the location relative to the HTML +# output directory using the MATHJAX_RELPATH option. The destination directory +# should contain the MathJax.js script. For instance, if the mathjax directory +# is located at the same level as the HTML output directory, then +# MATHJAX_RELPATH should be ../mathjax. The default value points to the MathJax +# Content Delivery Network so you can quickly see the result without installing +# MathJax. However, it is strongly recommended to install a local copy of +# MathJax from http://www.mathjax.org before deployment. +# The default value is: http://cdn.mathjax.org/mathjax/latest. +# This tag requires that the tag USE_MATHJAX is set to YES. MATHJAX_RELPATH = http://cdn.mathjax.org/mathjax/latest -# The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension -# names that should be enabled during MathJax rendering. - -MATHJAX_EXTENSIONS = - -# When the SEARCHENGINE tag is enabled doxygen will generate a search box -# for the HTML output. The underlying search engine uses javascript -# and DHTML and should work on any modern browser. Note that when using -# HTML help (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets -# (GENERATE_DOCSET) there is already a search function so this one should -# typically be disabled. For large projects the javascript based search engine -# can be slow, then enabling SERVER_BASED_SEARCH may provide a better solution. +# The MATHJAX_EXTENSIONS tag can be used to specify one or more MathJax +# extension names that should be enabled during MathJax rendering. For example +# MATHJAX_EXTENSIONS = TeX/AMSmath TeX/AMSsymbols +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_EXTENSIONS = + +# The MATHJAX_CODEFILE tag can be used to specify a file with javascript pieces +# of code that will be used on startup of the MathJax code. See the MathJax site +# (see: http://docs.mathjax.org/en/latest/output.html) for more details. For an +# example see the documentation. +# This tag requires that the tag USE_MATHJAX is set to YES. + +MATHJAX_CODEFILE = + +# When the SEARCHENGINE tag is enabled doxygen will generate a search box for +# the HTML output. The underlying search engine uses javascript and DHTML and +# should work on any modern browser. Note that when using HTML help +# (GENERATE_HTMLHELP), Qt help (GENERATE_QHP), or docsets (GENERATE_DOCSET) +# there is already a search function so this one should typically be disabled. +# For large projects the javascript based search engine can be slow, then +# enabling SERVER_BASED_SEARCH may provide a better solution. It is possible to +# search using the keyboard; to jump to the search box use + S +# (what the is depends on the OS and browser, but it is typically +# , /