phpdoctor.ini

   1 ; Default configuration file for PHPDoctor
   2
   3 ; This config file will cause PHPDoctor to generate API documentation of
   4 ; itself.
   5
   6
   7 ; PHPDoctor settings
   8 ; -----------------------------------------------------------------------------
   9
  10 ; Names of files to parse. This can be a single filename, or a comma separated
  11 ; list of filenames. Wildcards are allowed.
  12
  13 files = "*.php"
  14
  15 ; Names of files or directories to ignore. This can be a single filename, or a
  16 ; comma separated list of filenames. Wildcards are NOT allowed.
  17
  18 ignore = "CVS, .svn, .git, _compiled"
  19
  20 ; The directory to look for files in, if not used the PHPDoctor will look in
  21 ; the current directory (the directory it is run from).
  22
  23 source_path = "./"
  24
  25 ; If you do not want PHPDoctor to look in each sub directory for files
  26 ; uncomment this line.
  27
  28 ;subdirs = off
  29
  30 ; Set how loud PHPDoctor is as it runs. Quiet mode suppresses all output other
  31 ; than warnings and errors. Verbose mode outputs additional messages during
  32 ; execution.
  33
  34 ;quiet = on
  35 ;verbose = on
  36
  37 ; Select the doclet to use for generating output.
  38
  39 doclet = standard
  40 ;doclet = debug
  41
  42 ; The directory to find the doclet in. Doclets are expected to be in a
  43 ; directory named after themselves at the location given.
  44
  45 ;doclet_path = ./doclets
  46
  47 ; The directory to find taglets in. Taglets allow you to make PHPDoctor handle
  48 ; new tags and to alter the behavour of existing tags and their output.
  49
  50 ;taglet_path = ./taglets
  51
  52 ; If the code you are parsing does not use package tags or not all elements
  53 ; have package tags, use this setting to place unbound elements into a
  54 ; particular package.
  55
  56 default_package = "phpMyAdmin"
  57
  58 ; Specifies the name of a HTML file containing text for the overview
  59 ; documentation to be placed on the overview page. The path is relative to
  60 ; "source_path" unless an absolute path is given.
  61
  62 overview = readme.html
  63
  64 ; Package comments will be looked for in a file named package.html in the same
  65 ; directory as the first source file parsed in that package or in the directory
  66 ; given below. If package comments are placed in the directory given below then
  67 ; they should be named "<packageName>.html".
  68
  69 package_comment_dir = ./
  70
  71 ; Parse out global variables and/or global constants?
  72
  73 ;globals = off
  74 ;constants = off
  75
  76 ; Generate documentation for all class members
  77
  78 ;private = on
  79
  80 ; Generate documentation for public and protected class members
  81
  82 ;protected = on
  83
  84 ; Generate documentation for only public class members
  85
  86 ;public = on
  87
  88 ; Standard doclet settings
  89 ; -----------------------------------------------------------------------------
  90
  91 ; The directory to place generated documentation in. If the given path is
  92 ; relative to it will be relative to "source_path".
  93
  94 d = "apidoc"
  95
  96 ; Specifies the title to be placed in the HTML <title> tag.
  97
  98 windowtitle = "phpMyAdmin"
  99
 100 ; Specifies the title to be placed near the top of the overview summary file.
 101
 102 doctitle = "phpMyAdmin: The PHP Documentation Creator"
 103
 104 ; Specifies the header text to be placed at the top of each output file. The
 105 ; header will be placed to the right of the upper navigation bar.
 106
 107 header = "phpMyAdmin"
 108
 109 ; Specifies the footer text to be placed at the bottom of each output file. The
 110 ; footer will be placed to the right of the lower navigation bar.
 111
 112 footer = "phpMyAdmin"
 113
 114 ; Specifies the text to be placed at the bottom of each output file. The text
 115 ; will be placed at the bottom of the page, below the lower navigation bar.
 116
 117 ;bottom = "This document was generated by <a href="http://peej.github.com/phpdoctor/">PHPDoctor: The PHP Documentation Creator</a>"
 118
 119 ; Create a class tree?
 120
 121 ;tree = off
 122
 123 ; Use GeSHi to include formatted source files in the documentation
 124
 125 ;include_source = off
 126