[all-commits] [llvm/llvm-project] 7003f6: [clang-doc] Improving Markdown Output

Petr Hosek via All-commits all-commits at lists.llvm.org
Fri Mar 6 17:56:02 PST 2020


  Branch: refs/heads/master
  Home:   https://github.com/llvm/llvm-project
  Commit: 7003f64c1eb25e6a0dd10a4beabc3ca7bcaef7eb
      https://github.com/llvm/llvm-project/commit/7003f64c1eb25e6a0dd10a4beabc3ca7bcaef7eb
  Author: Petr Hosek <phosek at google.com>
  Date:   2020-03-06 (Fri, 06 Mar 2020)

  Changed paths:
    M clang-tools-extra/clang-doc/HTMLGenerator.cpp
    M clang-tools-extra/clang-doc/MDGenerator.cpp
    M clang-tools-extra/clang-doc/Representation.cpp
    M clang-tools-extra/clang-doc/Representation.h
    M clang-tools-extra/clang-doc/assets/index.js
    M clang-tools-extra/clang-doc/tool/ClangDocMain.cpp
    M clang-tools-extra/test/clang-doc/single-file.cpp
    M clang-tools-extra/unittests/clang-doc/HTMLGeneratorTest.cpp
    M clang-tools-extra/unittests/clang-doc/MDGeneratorTest.cpp

  Log Message:
  -----------
  [clang-doc] Improving Markdown Output

This change has two components. The moves the generated file
for a namespace to the directory named after the namespace in
a file named 'index.<format>'. This greatly improves the browsing
experience since the index page is shown by default for a directory.

The second improves the markdown output by adding the links to the
referenced pages for children objects and the link back to the source
code.

Patch By: Clayton

Differential Revision: https://reviews.llvm.org/D72954




More information about the All-commits mailing list