Lines Matching +full:docs +full:- +full:clang +full:- +full:html
2 Clang-Doc
10 :program:`clang-doc` is a tool for generating C and C++ documentation from
15 to `the LLVM bug tracker <https://github.com/llvm/llvm-project/issues/>`_ will definitely help the
22 :program:`clang-doc` is a `LibTooling
23 <https://clang.llvm.org/docs/LibTooling.html>`_-based tool, and so requires a
26 <https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html>`_).
30 .. code-block:: console
32 $ clang-doc File1.cpp File2.cpp ... FileN.cpp
36 .. code-block:: console
38 $ clang-doc --executor=all-TUs compile_commands.json
40 To select only a subset of files from the database, use the ``--filter`` flag:
42 .. code-block:: console
44 $ clang-doc --executor=all-TUs --filter=File[0-9]+.cpp compile_commands.json
49 :program:`clang-doc` produces a directory of documentation. One file is produced
53 The top-level directory is configurable through the ``output`` flag:
55 .. code-block:: console
57 $ clang-doc --output=output/directory/ compile_commands.json
62 Configuration for :program:`clang-doc` is currently limited to command-line options.
67 -------
69 :program:`clang-doc` offers the following options:
71 .. code-block:: console
73 $ clang-doc --help
78 $ clang-doc File1.cpp File2.cpp ... FileN.cpp
82 $ clang-doc --executor=all-TUs compile_commands.json
84 USAGE: clang-doc [options] <source0> [... <sourceN>]
90 -help - Display available options (-help-hidden for more)
91 -help-list - Display list of available options (-help-list-hidden for more)
92 -version - Display the version of this program
94 clang-doc options:
96 --doxygen - Use only doxygen-style comments to generate docs.
97 --extra-arg=<string> - Additional argument to append to the compiler command line
99 --extra-arg-before=<string> - Additional argument to prepend to the compiler command line
101 --format=<value> - Format for outputted docs.
102 =yaml - Documentation in YAML format.
103 =md - Documentation in MD format.
104 =html - Documentation in HTML format.
105 --ignore-map-errors - Continue if files are not mapped correctly.
106 --output=<string> - Directory for outputting generated files.
107 -p <string> - Build path
108 --project-name=<string> - Name of project.
109 --public - Document only public declarations.
110 --repository=<string> -
113 --source-root=<string> -
117 --stylesheets=<string> - CSS stylesheets to extend the default styles.
119 The following flags should only be used if ``format`` is set to ``html``:
120 - ``repository``
121 - ``source-root``
122 - ``stylesheets``