[clang-doc] Update documentation

[DiegoAstiazaran]

Summary

HTML generator has been included in clang-tools-extra release notes.
clang-doc documentation file has been updated.

[Eugene.Zelenko]

clang-tools-extra/docs/clang-doc.rst

93 ↗

(On Diff #212934)

It'll be reasonable to mention that this options make sense only for HTML output.

[jakehehrlich]

This looks fine to me

[DiegoAstiazaran]

Specify that stylesheets flag is only required for html format.

[juliehockett]

Sorry for the delayed review, but a few things I caught :)

Also, please make sure to update the the release notes/flag documentation for the patches you have in progress that add features or flags.

clang-tools-extra/trunk/docs/ReleaseNotes.rst

55

This should also include new flags and new features like template handling.

clang-tools-extra/trunk/docs/clang-doc.rst

40

For this to work, you'd also need to pass the --executor=standalone flag.

clang-tools-extra/trunk/docs/ReleaseNotes.rst

 Improvements to clangd
 ----------------------
 
 The improvements are...
 
 Improvements to clang-doc
 -------------------------
 
-The improvements are...
+- :doc:`clang-doc <clang-doc>` now generates documentation in HTML format.
 
 Improvements to clang-query
 ---------------------------
 
 The improvements are...
 
 Improvements to clang-rename
 ----------------------------

clang-tools-extra/trunk/docs/clang-doc.rst

 
 The tool is in a very early development stage, so you might encounter bugs and
 crashes. Submitting reports with information about how to reproduce the issue
 to `the LLVM bugtracker <https://llvm.org/bugs>`_ will definitely help the
 project. If you have any ideas or suggestions, please to put a feature request
 there.
 
 Use
-=====
+===
 
 :program:`clang-doc` is a `LibTooling
 <https://clang.llvm.org/docs/LibTooling.html>`_-based tool, and so requires a
 compile command database for your project (for an example of how to do this 
 see `How To Setup Tooling For LLVM
 <https://clang.llvm.org/docs/HowToSetupToolingForLLVM.html>`_).
 
-The tool can be used on a single file or multiple files as defined in 
-the compile commands database:
+By default, the tool will run on all files listed in the given compile commands
+database:
 
 .. code-block:: console
 
-  $ clang-doc /path/to/file.cpp -p /path/to/compile/commands
+  $ clang-doc /path/to/compile_commands.json
 
-This generates an intermediate representation of the declarations and their
-associated information in the specified TUs, serialized to LLVM bitcode.
+The tool can also be used on a single file or multiple files if a build path is
+passed with the ``-p`` flag.
 
-As currently implemented, the tool is only able to parse TUs that can be 
-stored in-memory. Future additions will extend the current framework to use
-map-reduce frameworks to allow for use with large codebases.
+.. code-block:: console
+
+  $ clang-doc /path/to/file.cpp -p /path/to/build
+
+Output
+======
+
+:program:`clang-doc` produces a directory of documentation. One file is produced
+for each namespace and record in the project source code, containing all
+documentation (including contained functions, methods, and enums) for that item.
+
+The top-level directory is configurable through the ``output`` flag:
+
+.. code-block:: console
+
+  $ clang-doc -output=output/directory/ compile_commands.json
+
+Configuration
+=============
+
+Configuration for :program:`clang-doc` is currently limited to command-line options.
+In the future, it may develop the ability to use a configuration file, but no such
+efforts are currently in progress.
+
+Options
+-------
 
 :program:`clang-doc` offers the following options:
 
 .. code-block:: console
 
   $ clang-doc --help
   USAGE: clang-doc [options] <source0> [... <sourceN>]
 
   OPTIONS:
 
   Generic Options:
 
     -help                      - Display available options (-help-hidden for more)
     -help-list                 - Display list of available options (-help-list-hidden for more)
     -version                   - Display the version of this program
 
   clang-doc options:
 
     -doxygen                   - Use only doxygen-style comments to generate docs.
     -dump                      - Dump intermediate results to bitcode file.
     -extra-arg=<string>        - Additional argument to append to the compiler command line
     -extra-arg-before=<string> - Additional argument to prepend to the compiler command line
-    -omit-filenames            - Omit filenames in output.
+    --format=<value>           - Format for outputted docs.
+      =yaml                    -   Documentation in YAML format.
+      =md                      -   Documentation in MD format.
+      =html                    -   Documentation in HTML format.
     -output=<string>           - Directory for outputting generated files.
     -p=<string>                - Build path
+    --public                   - Document only public declarations.
+    --stylesheets=<string>     - CSS stylesheets to extend the default styles.
+
+``stylesheets`` should only be used if ``format`` is set to ``html``.