.codedocs (1910B)
1 # CodeDocs.xyz Configuration File 2 3 # Optional project name, if left empty the GitHub repository name will be used. 4 PROJECT_NAME = 5 6 # One or more directories and files that contain example code to be included. 7 EXAMPLE_PATH = 8 9 # One or more directories and files to exclude from documentation generation. 10 # Use relative paths with respect to the repository root directory. 11 EXCLUDE = test/gtest-1.8.0/ 12 13 # One or more wildcard patterns to exclude files and directories from document 14 # generation. 15 EXCLUDE_PATTERNS = 16 17 # One or more symbols to exclude from document generation. Symbols can be 18 # namespaces, classes, or functions. 19 EXCLUDE_SYMBOLS = 20 21 # Override the default parser (language) used for each file extension. 22 EXTENSION_MAPPING = 23 24 # Set the wildcard patterns used to filter out the source-files. 25 # If left blank the default is: 26 # *.c, *.cc, *.cxx, *.cpp, *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, 27 # *.idl, *.ddl, *.odl, *.h, *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, 28 # *.php4, *.php5, *.phtml, *.inc, *.m, *.markdown, *.md, *.mm, *.dox, *.py, 29 # *.f90, *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. 30 FILE_PATTERNS = 31 32 # Hide undocumented class members. 33 HIDE_UNDOC_MEMBERS = 34 35 # Hide undocumented classes. 36 HIDE_UNDOC_CLASSES = 37 38 # Specify a markdown page whose contents should be used as the main page 39 # (index.html). This will override a page marked as \mainpage. For example, a 40 # README.md file usually serves as a useful main page. 41 USE_MDFILE_AS_MAINPAGE = README.md 42 43 # Specify external repository to link documentation with. 44 # This is similar to Doxygen's TAGFILES option, but will automatically link to 45 # tags of other repositories already using CodeDocs. List each repository to 46 # link with by giving its location in the form of owner/repository. 47 # For example: 48 # TAGLINKS = doxygen/doxygen CodeDocs/osg 49 # Note: these repositories must already be built on CodeDocs. 50 TAGLINKS =