| # Doxyfile 1.8.4 |
| |
| # This file describes the settings to be used by the documentation system |
| # doxygen (www.doxygen.org) for a project. |
| # |
| # All text after a double hash (##) is considered a comment and is placed |
| # in front of the TAG it is preceding . |
| # All text after a hash (#) is considered a comment and will be ignored. |
| # The format is: |
| # TAG = value [value, ...] |
| # For lists items can also be appended using: |
| # TAG += value [value, ...] |
| # Values that contain spaces should be placed between quotes (" "). |
| |
| @INCLUDE = developer.doxyfile |
| |
| |
| #--------------------------------------------------------------------------- |
| # Project related configuration options |
| #--------------------------------------------------------------------------- |
| |
| # Using the PROJECT_BRIEF tag one can provide an optional one line description |
| # for a project that appears at the top of each page and should give viewer a |
| # quick idea about the purpose of the project. Keep the description short. |
| |
| PROJECT_BRIEF = "User Documentation for Apache MADlib" |
| |
| # With the PROJECT_LOGO tag one can specify an logo or icon that is |
| # included in the documentation. The maximum height of the logo should not |
| # exceed 55 pixels and the maximum width should not exceed 200 pixels. |
| # Doxygen will copy the logo to the output directory. |
| |
| PROJECT_LOGO = ../imgs/madlib.png |
| |
| # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) |
| # base path where the generated documentation will be put. |
| # If a relative path is entered, it will be relative to the location |
| # where doxygen was started. If left blank the current directory will be used. |
| |
| # Note: For madlib, we want this to be a path relative to the repository root. |
| |
| OUTPUT_DIRECTORY = @DOXYGEN_OUTPUT_USER@ |
| |
| #--------------------------------------------------------------------------- |
| # Build related configuration options |
| #--------------------------------------------------------------------------- |
| |
| # If the EXTRACT_PRIVATE tag is set to YES all private members of a class |
| # will be included in the documentation. |
| |
| EXTRACT_PRIVATE = NO |
| |
| # If the EXTRACT_PACKAGE tag is set to YES all members with package or internal |
| # scope will be included in the documentation. |
| |
| EXTRACT_PACKAGE = NO |
| |
| # If the EXTRACT_STATIC tag is set to YES all static members of a file |
| # will be included in the documentation. |
| |
| EXTRACT_STATIC = NO |
| |
| # The INTERNAL_DOCS tag determines if documentation |
| # that is typed after a \internal command is included. If the tag is set |
| # to NO (the default) then the documentation will be excluded. |
| # Set it to YES to include the internal documentation. |
| |
| INTERNAL_DOCS = NO |
| |
| # Set the SHOW_USED_FILES tag to NO to disable the list of files generated |
| # at the bottom of the documentation of classes and structs. If set to YES the |
| # list will mention the files that were used to generate the documentation. |
| |
| SHOW_USED_FILES = NO |
| |
| # Set the SHOW_FILES tag to NO to disable the generation of the Files page. |
| # This will remove the Files entry from the Quick Index and from the |
| # Folder Tree View (if specified). The default is YES. |
| |
| SHOW_FILES = YES |
| |
| # Set the SHOW_NAMESPACES tag to NO to disable the generation of the |
| # Namespaces page. |
| # This will remove the Namespaces entry from the Quick Index |
| # and from the Folder Tree View (if specified). The default is YES. |
| |
| SHOW_NAMESPACES = NO |
| |
| # If the value of the INPUT tag contains directories, you can use the |
| # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp |
| # and *.h) to filter out the source-files in the directories. If left |
| # blank the following patterns are tested: |
| # *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh |
| # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py |
| # *.f90 *.f *.for *.vhd *.vhdl |
| |
| FILE_PATTERNS = *.dox \ |
| *.sql_in |
| |
| # Doxygen selects the parser to use depending on the extension of the files it |
| # parses. With this tag you can assign which parser to use for a given extension. |
| # Doxygen has a built-in mapping, but you can override or extend it using this |
| # tag. The format is ext=language, where ext is a file extension, and language |
| # is one of the parsers supported by doxygen: IDL, Java, Javascript, CSharp, C, |
| # C++, D, PHP, Objective-C, Python, Fortran, VHDL, C, C++. For instance to make |
| # doxygen treat .inc files as Fortran files (default is PHP), and .f files as C |
| # (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions |
| # you also need to set FILE_PATTERNS otherwise the files are not read by doxygen. |
| |
| EXTENSION_MAPPING = sql_in=C++ |
| |
| #--------------------------------------------------------------------------- |
| # configuration options related to the input files |
| #--------------------------------------------------------------------------- |
| |
| # The INPUT tag can be used to specify the files and/or directories that contain |
| # documented source files. You may enter file names like "myfile.cpp" or |
| # directories like "/usr/src/myproject". Separate the files or directories |
| # with spaces. |
| |
| INPUT = @DOXYGEN_INPUT_USER@ |
| |
| #--------------------------------------------------------------------------- |
| # configuration options related to the HTML output |
| #--------------------------------------------------------------------------- |
| |
| # Enable the USE_MATHJAX option to render LaTeX formulas using MathJax |
| # (see http://www.mathjax.org) which uses client side Javascript for the |
| # rendering instead of using prerendered bitmaps. Use this if you do not |
| # have LaTeX installed or if you want formulas to look prettier in the HTML |
| # output. When enabled you also need to install MathJax separately and |
| # configure the path to it using the MATHJAX_RELPATH option. |
| |
| USE_MATHJAX = @DOXYGEN_USE_MATHJAX@ |
| |
| # When MathJax is enabled you can set the default output format to be used for |
| # the MathJax output. Supported types are HTML-CSS, NativeMML (i.e. MathML) and |
| # SVG. The default value is HTML-CSS, which is slower, but has the best |
| # compatibility. |
| |
| MATHJAX_FORMAT = HTML-CSS |
| |
| # When MathJax is enabled you need to specify the location relative to the |
| # HTML output directory using the MATHJAX_RELPATH option. The destination |
| # directory should contain the MathJax.js script. For instance, if the mathjax |
| # directory is located at the same level as the HTML output directory, then |
| # MATHJAX_RELPATH should be ../mathjax. The default value points to |
| # the MathJax Content Delivery Network so you can quickly see the result without |
| # installing MathJax. |
| # However, it is strongly recommended to install a local |
| # copy of MathJax from http://www.mathjax.org before deployment. |
| |
| # MATHJAX_RELPATH = @DOXYGEN_MATHJAX_RELPATH@ |
| @MATHJAX_RELPATH_CONFIG@ |
| |
| # The MATHJAX_EXTENSIONS tag can be used to specify one or MathJax extension |
| # names that should be enabled during MathJax rendering. |
| |
| MATHJAX_EXTENSIONS = TeX/AMSmath \ |
| TeX/AMSsymbols |
| |
| #--------------------------------------------------------------------------- |
| # configuration options related to source browsing |
| #--------------------------------------------------------------------------- |
| |
| # If the SOURCE_BROWSER tag is set to YES then a list of source files will |
| # be generated. Documented entities will be cross-referenced with these sources. |
| # Note: To get rid of all source code in the generated output, make sure also |
| # VERBATIM_HEADERS is set to NO. |
| |
| SOURCE_BROWSER = NO |
| |
| # If the VERBATIM_HEADERS tag is set to YES (the default) then Doxygen |
| # will generate a verbatim copy of the header file for each class for |
| # which an include is specified. Set to NO to disable this. |
| |
| VERBATIM_HEADERS = NO |
| |
| #--------------------------------------------------------------------------- |
| # Configuration options related to the dot tool |
| #--------------------------------------------------------------------------- |
| |
| # If the CLASS_DIAGRAMS tag is set to YES (the default) Doxygen will |
| # generate a inheritance diagram (in HTML, RTF and LaTeX) for classes with base |
| # or super classes. Setting the tag to NO turns the diagrams off. Note that |
| # this option also works with HAVE_DOT disabled, but it is recommended to |
| # install and use dot, since it yields more powerful graphs. |
| |
| CLASS_DIAGRAMS = NO |
| |
| # If the CLASS_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| # will generate a graph for each documented class showing the direct and |
| # indirect inheritance relations. Setting this tag to YES will force the |
| # CLASS_DIAGRAMS tag to NO. |
| |
| CLASS_GRAPH = NO |
| |
| # If the COLLABORATION_GRAPH and HAVE_DOT tags are set to YES then doxygen |
| # will generate a graph for each documented class showing the direct and |
| # indirect implementation dependencies (inheritance, containment, and |
| # class references variables) of the class with other documented classes. |
| |
| COLLABORATION_GRAPH = NO |
| |
| # If the GROUP_GRAPHS and HAVE_DOT tags are set to YES then doxygen |
| # will generate a graph for groups, showing the direct groups dependencies |
| |
| GROUP_GRAPHS = NO |
| |
| # If the DIRECTORY_GRAPH and HAVE_DOT tags are set to YES |
| # then doxygen will show the dependencies a directory has on other directories |
| # in a graphical way. The dependency relations are determined by the #include |
| # relations between the files in the directories. |
| |
| DIRECTORY_GRAPH = NO |