1;; phpDocumentor.ini 2;; 3;; contains all the runtime values that are configurable. 4;; This is moved from phpdoc.inc, to remove the necessity to edit the php code and 5;; simplify debugging 6[DEBUG] 7;; If you want to see the internals of the parser in action, set this to true 8PHPDOCUMENTOR_DEBUG = false 9;; set to true if you want to eliminate extra whitespace in doc comments (slows things down quite a bit) 10PHPDOCUMENTOR_KILL_WHITESPACE = false 11 12[_phpDocumentor_options] 13;; this is the value that will be displayed as the root directory 14Program_Root = 15;; uncomment this to set the path phpDocumentor looks in to find user files 16;userdir = user/ 17 18;; Use useconfig if you want to be able to run phpdoc with no command-line options (!!) 19;; change the value of useconfig to an .ini file that is in users/ (like greg.ini) 20;[_phpDocumentor_setting] 21;useconfig = default 22 23;; set max memory usage size to be very high, to avoid it crashing it the middle of its run 24;; due to using a boatload of memory 25;;memory_limit = 512M 26 27[_phpDocumentor_phpfile_exts] 28php 29php3 30php4 31phtml 32inc 33 34;; deprecated in 1.2 35;; this list is informational only - the following tags will be parsed as 36;; having meaning, everything else will be treated as text by the output 37;; converter, meaning in the HTML converter, all other tags will be htmlentitied 38;[_phpDocumentor_html_allowed] 39;ul 40;ol 41;li 42;p 43;strong 44;pre 45;a 46;code 47;br 48;var 49;samp 50;kbd 51 52[_phpDocumentor_tags_allowed] 53abstract 54access 55author 56category 57copyright 58;; for Zend IDE support - minimal at best 59desc 60deprec 61deprecated 62example 63exception 64filesource 65final 66global 67ignore 68internal 69license 70link 71magic 72name 73package 74param 75parameter 76return 77;; alias for @return 78returns 79see 80since 81source 82static 83staticvar 84subpackage 85throws 86todo 87TODO 88tutorial 89uses 90var 91version 92;; compat tags, things wont parse right in incorrectly documented code without them 93;; hopefully better error handling in handleDockeyword allows these to go away 94;; this is a dumb tag included for pear compatability see bug# 558028 95extends 96private 97public 98 99[_phpDocumentor_inline_doc_tags_allowed] 100example 101inheritdoc 102internal 103link 104source 105tutorial 106 107[_phpDocumentor_inline_tutorial_tags_allowed] 108category 109example 110id 111link 112toc 113tutorial 114 115;; custom files to include in RIC 116;; these MUST be in upper-case 117[_phpDocumentor_RIC_files] 118README 119INSTALL 120CHANGELOG 121FAQ 122NEWS 123