This is an archive of the discontinued LLVM Phabricator instance.

[clang-tools-extra] Cleanup documentation routine
ClosedPublic

Authored by omtcyfz on May 30 2018, 8:25 AM.

Details

Summary
  • Doxygen didn't generate documentation for a bunch of existing tools due to the absence of their directories in the doxygen configuration file. This patch adds all relevant directories to the appropriate list.
  • clang-tools-extra/docs/Doxyfile seems to be unused and irrelevant, doxygen.cfg.in is passed to the CMake's Doxygen invocation, hence Doxyfile is removed.

The validity of proposed changes was manually checked by building doxygen-clang-tools and making sure that clangd and other tools are present in Doxygen-generated docs of clang-tools-extra

Diff Detail

Repository
rL LLVM

Event Timeline

omtcyfz created this revision.May 30 2018, 8:25 AM
omtcyfz updated this revision to Diff 149138.May 30 2018, 9:30 AM
omtcyfz retitled this revision from [clang-rename] Move clang-rename documentation to Clang repository to [clang-tools-extra] Cleanup documentation routine.
omtcyfz edited the summary of this revision. (Show Details)

I also noticed that some directories in clang-tools-extra are not present in Doxygen configuration file and hence these directories are not processed. I removed irrelevant Doxygen configuration file (which seems to be abandoned and unused) and updated the input list.

ioeric added inline comments.Jun 1 2018, 2:21 AM
clang-tools-extra/docs/index.rst
27 ↗(On Diff #149138)

It seems that the clang-rename tool is still in the extra repository. I think we should probably "advertise" clang-rename as part of clang-refactor in the future. That said, we might want to wait until we have proper documentation for clang-refactor in clang. WDYT?

omtcyfz updated this revision to Diff 150083.Jun 6 2018, 1:03 AM
omtcyfz edited the summary of this revision. (Show Details)

Leave clang-rename docs in cfe-tools-extra repository, keep the second part of the patch.

@ioeric makes sense to me, I have reverted the first part of the patch while only leaving the second part of the cleanup, which might still be useful.

ioeric accepted this revision.Jul 3 2018, 6:50 AM

lgtm. Thanks for doing this!

This revision is now accepted and ready to land.Jul 3 2018, 6:50 AM
This revision was automatically updated to reflect the committed changes.