Skip to content

Commit d36820f

Browse files
committed
Sync with changes from r300825 in clang.
Generate the better include paths. Instead of #include <llvm_header.h> doxygen produces #include "llvm/Folder/llvm_header.h" Patch by Yuka Takahashi (D32342)! llvm-svn: 301569
1 parent 2a68486 commit d36820f

File tree

3 files changed

+28
-12
lines changed

3 files changed

+28
-12
lines changed

llvm/docs/CMakeLists.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11

22
if (DOXYGEN_FOUND)
33
if (LLVM_ENABLE_DOXYGEN)
4-
set(abs_top_srcdir ${LLVM_MAIN_SRC_DIR})
5-
set(abs_top_builddir ${LLVM_BINARY_DIR})
4+
set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
5+
set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
66

77
if (HAVE_DOT)
88
set(DOT ${LLVM_PATH_DOT})

llvm/docs/README.txt

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,3 +51,18 @@ running:
5151

5252
cd docs/
5353
make -f Makefile.sphinx linkcheck
54+
55+
Doxygen page Output
56+
==============
57+
58+
Install doxygen <http://www.stack.nl/~dimitri/doxygen/download.html> and dot2tex <https://dot2tex.readthedocs.io/en/latest>.
59+
60+
cd <build-dir>
61+
cmake -DLLVM_ENABLE_DOXYGEN=On <llvm-top-src-dir>
62+
make doxygen-llvm # for LLVM docs
63+
make doxygen-clang # for clang docs
64+
65+
It will generate html in
66+
67+
<build-dir>/docs/doxygen/html # for LLVM docs
68+
<build-dir>/tools/clang/docs/doxygen/html # for clang docs

llvm/docs/doxygen.cfg.in

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
61+
OUTPUT_DIRECTORY = @abs_top_builddir@/doxygen
6262

6363
# If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -132,7 +132,7 @@ INLINE_INHERITED_MEMB = NO
132132
# shortest path that makes the file name unique will be used
133133
# The default value is: YES.
134134

135-
FULL_PATH_NAMES = NO
135+
FULL_PATH_NAMES = YES
136136

137137
# The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
138138
# Stripping is only done if one of the specified strings matches the left-hand
@@ -144,7 +144,7 @@ FULL_PATH_NAMES = NO
144144
# will be relative from the directory where doxygen is started.
145145
# This tag requires that the tag FULL_PATH_NAMES is set to YES.
146146

147-
STRIP_FROM_PATH = ../..
147+
STRIP_FROM_PATH = @abs_top_srcdir@/..
148148

149149
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
150150
# path mentioned in the documentation of a class, which tells the reader which
@@ -153,7 +153,8 @@ STRIP_FROM_PATH = ../..
153153
# specify the list of include paths that are normally passed to the compiler
154154
# using the -I flag.
155155

156-
STRIP_FROM_INC_PATH =
156+
STRIP_FROM_INC_PATH = @abs_top_srcdir@/../include
157+
STRIP_FROM_INC_PATH += @abs_top_srcdir@/../lib
157158

158159
# If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
159160
# less readable) file names. This can be useful is your file systems doesn't
@@ -513,7 +514,7 @@ SHOW_GROUPED_MEMB_INC = NO
513514
# files with double quotes in the documentation rather than with sharp brackets.
514515
# The default value is: NO.
515516

516-
FORCE_LOCAL_INCLUDES = NO
517+
FORCE_LOCAL_INCLUDES = YES
517518

518519
# If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
519520
# documentation for inline members.
@@ -743,9 +744,9 @@ WARN_LOGFILE =
743744
# spaces.
744745
# Note: If this tag is empty the current directory is searched.
745746

746-
INPUT = @abs_top_srcdir@/include \
747-
@abs_top_srcdir@/lib \
748-
@abs_top_srcdir@/docs/doxygen-mainpage.dox
747+
INPUT = @abs_top_srcdir@/../include \
748+
@abs_top_srcdir@/../lib \
749+
@abs_top_srcdir@/doxygen-mainpage.dox
749750

750751
# This tag can be used to specify the character encoding of the source files
751752
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -813,7 +814,7 @@ EXCLUDE_SYMBOLS =
813814
# that contain example code fragments that are included (see the \include
814815
# command).
815816

816-
EXAMPLE_PATH = @abs_top_srcdir@/examples
817+
EXAMPLE_PATH = @abs_top_srcdir@/../examples
817818

818819
# If the value of the EXAMPLE_PATH tag contains directories, you can use the
819820
# EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
@@ -833,7 +834,7 @@ EXAMPLE_RECURSIVE = YES
833834
# that contain images that are to be included in the documentation (see the
834835
# \image command).
835836

836-
IMAGE_PATH = @abs_top_srcdir@/docs/img
837+
IMAGE_PATH = @abs_top_srcdir@/img
837838

838839
# The INPUT_FILTER tag can be used to specify a program that doxygen should
839840
# invoke to filter for each input file. Doxygen will invoke the filter program

0 commit comments

Comments
 (0)