mods/phpdoc2/PhpDocumentor/phpDocumentor.ini

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