Home

Paul Novotny edited this page May 18, 2016 · 3 revisions
Clone this wiki locally

CodeDocs is like continuous integration for your documentation: with every commit, your documentation is generated and anyone can see it at https://codedocs.xyz/UsernameOrOrg/RepoName. Documentation is generated with Doxygen, but by default CodeDocs does not look for any existing doxyfile you may have. Configuration is done via a .codedocs file in the root of your repository.

.codedocs file

A .codedocs file is similar to a doxyfile, but only a subset of options are whitelisted, along with some special options unique to CodeDocs. All options are specified in the format VAR_NAME = value/or/path, and backslashes can escape newlines to span multiple lines.

These Doxygen options are whitelisted (and possibly others):

  • ABBREVIATE_BRIEF
  • ALIASES
  • ALPHABETICAL_INDEX
  • ALWAYS_DETAILED_SEC
  • CASE_SENSE_NAMES
  • CLASS_DIAGRAMS
  • DISABLE_INDEX
  • DISTRIBUTE_GROUP_DOC
  • EXAMPLE_PATH
  • EXCLUDE
  • EXCLUDE_PATTERNS
  • EXCLUDE_SYMBOLS
  • EXTRACT_LOCAL_CLASSES
  • FILE_PATTERNS
  • GENERATE_TREEVIEW
  • HIDE_COMPOUND_REFERENCE
  • HIDE_SCOPE_NAMES
  • HIDE_UNDOC_CLASSES
  • HIDE_UNDOC_MEMBERS
  • HTML_TIMESTAMP
  • INLINE_GROUPED_CLASSES
  • INPUT_ENCODING
  • INTERNAL_DOCS
  • LAYOUT_FILE (default only)
  • OPTIMIZE_OUTPUT_FOR_C
  • PROJECT_BRIEF
  • PROJECT_NAME
  • PROJECT_NUMBER
  • SHORT_NAMES
  • SHOW_FILES
  • SHOW_INCLUDE_FILES
  • SHOW_NAMESPACES
  • SORT_BRIEF_DOCS
  • SORT_BY_SCOPE_NAME
  • SORT_MEMBER_DOCS
  • STRICT_PROTO_MATCHING
  • TYPEDEF_HIDES_STRUCT
  • USE_MDFILE_AS_MAINPAGE
  • VERBATIM_HEADERS

Below are options unique to CodeDocs.

DOXYFILE

If you have an existing doxyfile that you would like to use, set this variable to the relative path to it. You can override the values in the doxyfile with values in the .codedocs file.

TAGLINKS

If you have multiple repositories and need to cross link documentation, you can specify the repositories here in the form UsernameOrOrg/RepoName and CodeDocs will include the doxygen tag files.