; Default configuration file for PHPDoctor ; This config file will cause PHPDoctor to generate API documentation of itself. ; Names of files to parse. This can be a single filename, or a comma separated ; list of filenames. Wildcards are allowed. files = "cmsdam*.php" ; The directory to look for files in, if not used the PHPDoctor will look in ; the current directory (the directory it is run from). This SHOULD end in ; a trailing slash. file_path = "../../classes/" ; If you want PHPDoctor to look in each sub directory for files uncomment this ; line. ;subdirs = on ; Instead of listing files above, you can create a file containing a list of ; filenames, one per line. Specify your list file below. ;file_list = "" ; The directory to place generated documentation in. The path is relative to ; "file_path" or the current directory. This SHOULD end is a trailing slash. output_dir = "../docs/apidocs/" ; Documentation title, used on the overview page. This may include HTML, use ; the "overview" directive to add more information to the overview page. title = "cmsdAm, the simple cms generation!!" ; Short documentation title, used in the page title and to the right of the ; navigation bars. This must not include HTML tags. short_title = "cmsdAm 0.8" ; Specifies the name of a file containing text for the overview documentation ; to be placed on the overview page. The path is relative to "file_path" or the ; current directory. overview_comment = README.html ; Specifies the directory that package comments are stored in. Package comments ; should be HTML files named "packageName.html". The directory name SHOULD end ; in a trailing slash. package_comment_dir = ../docs/packages ; Specifies the text to be placed at the bottom of each output file. The text ; will be placed at the bottom of the page, below the lower navigation bar. The ; text may contain HTML tags and white space. ;footer "Text" ; Default package name default_package = "cmsdAm" ; Template to use, this should be the name of the template folder to use in the ; PHPDoctor templates directory. ;template = "default" ; Create documentation for globals and/or constants? globals = on constants = on ; Create a class tree? tree = on ; Display warnings, uncomment to stop PHPDoctor reporting about incorrect tags ;warnings = false ; Don't generate documentation for private class members ;hide_private = on