This is an archive of the discontinued LLVM Phabricator instance.

Differential D47537

[clang-tools-extra] Cleanup documentation routine
ClosedPublic

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

Details

Reviewers
ioeric
klimek
Commits
rGd666f9bdacc2: [clang-tools-extra] Cleanup documentation routine
rCTE336257: [clang-tools-extra] Cleanup documentation routine
rL336257: [clang-tools-extra] Cleanup documentation routine
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

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.

Herald added a subscriber: ilya-biryukov. · View Herald TranscriptMay 30 2018, 9:30 AM
ioeric added inline comments.Jun 1 2018, 2:21 AM
clang-tools-extra/docs/index.rst
27

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.

omtcyfz added a comment.Jun 6 2018, 1:04 AM

@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.

omtcyfz removed a reviewer: arphaman.Jun 17 2018, 12:57 AM
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
Closed by commit rL336257: [clang-tools-extra] Cleanup documentation routine (authored by omtcyfz). · Explain WhyJul 4 2018, 3:22 AM
This revision was automatically updated to reflect the committed changes.
Herald added a subscriber: llvm-commits. · View Herald TranscriptJul 4 2018, 3:22 AM

Revision Contents

PathSize
clang-tools-extra/
docs/
1 line
1 line
clang/
docs/
clang-tools-extra/
docs/
ClangRename.rst
clang-rename.rst
2 lines
clang/
docs/
1 line

Diff 149120

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

  • This file was moved to clang/docs/ClangRename.rst.

clang-tools-extra/docs/doxygen.cfg.in

Show First 20 Lines • Show All 741 Lines • ▼ Show 20 Lines
# directories like /usr/src/myproject. Separate the files or directories with # directories like /usr/src/myproject. Separate the files or directories with
# spaces. # spaces.
# Note: If this tag is empty the current directory is searched. # Note: If this tag is empty the current directory is searched.
INPUT = \ INPUT = \
@abs_srcdir@/../clang-tidy \ @abs_srcdir@/../clang-tidy \
@abs_srcdir@/../clang-apply-replacements \ @abs_srcdir@/../clang-apply-replacements \
@abs_srcdir@/../clang-query \ @abs_srcdir@/../clang-query \
@abs_srcdir@/../clang-rename \
@abs_srcdir@/../modularize \ @abs_srcdir@/../modularize \
@abs_srcdir@/../pp-trace \ @abs_srcdir@/../pp-trace \
@abs_srcdir@/../tool-template \ @abs_srcdir@/../tool-template \
@abs_srcdir@/doxygen-mainpage.dox @abs_srcdir@/doxygen-mainpage.dox
# This tag can be used to specify the character encoding of the source files # This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
# libiconv (or the iconv built into libc) for the transcoding. See the libiconv # libiconv (or the iconv built into libc) for the transcoding. See the libiconv
▲ Show 20 Lines • Show All 1,542 Lines • Show Last 20 Lines

clang-tools-extra/docs/index.rst

Show All 18 Lines
======== ========
.. toctree:: .. toctree::
:maxdepth: 2 :maxdepth: 2
clang-tidy/index clang-tidy/index
include-fixer include-fixer
modularize modularize
pp-trace pp-trace
clang-rename
ioericUnsubmitted
Not Done
ReplyInline Actions

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?

ioeric: It seems that the clang-rename tool is still in the extra repository. I think we should…
clangd clangd
clang-doc clang-doc
Doxygen Documentation Doxygen Documentation
===================== =====================
The Doxygen documentation describes the **internal** software that makes up the The Doxygen documentation describes the **internal** software that makes up the
tools of clang-tools-extra, not the **external** use of these tools. The Doxygen tools of clang-tools-extra, not the **external** use of these tools. The Doxygen
Show All 19 Lines

clang/docs/ClangRename.rst

  • This file was moved from clang-tools-extra/docs/clang-rename.rst.
============ ============
Clang-Rename ClangRename
============ ============
.. contents:: .. contents::
See also: See also:
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
▲ Show 20 Lines • Show All 156 Lines • Show Last 20 Lines

clang/docs/index.rst

Show First 20 Lines • Show All 68 Lines • ▼ Show 20 Lines
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
ClangTools ClangTools
ClangCheck ClangCheck
ClangFormat ClangFormat
ClangFormatStyleOptions ClangFormatStyleOptions
ClangRename
Design Documents Design Documents
================ ================
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
InternalsManual InternalsManual
Show All 14 Lines