llvm.org GIT mirror llvm / 94e7e88
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)! git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@301569 91177308-0d34-0410-b5e6-96231b3b80d8 Vassil Vassilev 2 years ago
3 changed file(s) with 28 addition(s) and 12 deletion(s). Raw diff Collapse all Expand all
0
11 if (DOXYGEN_FOUND)
22 if (LLVM_ENABLE_DOXYGEN)
3 set(abs_top_srcdir ${LLVM_MAIN_SRC_DIR})
4 set(abs_top_builddir ${LLVM_BINARY_DIR})
3 set(abs_top_srcdir ${CMAKE_CURRENT_SOURCE_DIR})
4 set(abs_top_builddir ${CMAKE_CURRENT_BINARY_DIR})
55
66 if (HAVE_DOT)
77 set(DOT ${LLVM_PATH_DOT})
5050
5151 cd docs/
5252 make -f Makefile.sphinx linkcheck
53
54 Doxygen page Output
55 ==============
56
57 Install doxygen and dot2tex .
58
59 cd
60 cmake -DLLVM_ENABLE_DOXYGEN=On
61 make doxygen-llvm # for LLVM docs
62 make doxygen-clang # for clang docs
63
64 It will generate html in
65
66 /docs/doxygen/html # for LLVM docs
67 /tools/clang/docs/doxygen/html # for clang docs
5757 # entered, it will be relative to the location where doxygen was started. If
5858 # left blank the current directory will be used.
5959
60 OUTPUT_DIRECTORY = @abs_top_builddir@/docs/doxygen
60 OUTPUT_DIRECTORY = @abs_top_builddir@/doxygen
6161
6262 # If the CREATE_SUBDIRS tag is set to YES, then doxygen will create 4096 sub-
6363 # directories (in 2 levels) under the output directory of each output format and
131131 # shortest path that makes the file name unique will be used
132132 # The default value is: YES.
133133
134 FULL_PATH_NAMES = NO
134 FULL_PATH_NAMES = YES
135135
136136 # The STRIP_FROM_PATH tag can be used to strip a user-defined part of the path.
137137 # Stripping is only done if one of the specified strings matches the left-hand
143143 # will be relative from the directory where doxygen is started.
144144 # This tag requires that the tag FULL_PATH_NAMES is set to YES.
145145
146 STRIP_FROM_PATH = ../..
146 STRIP_FROM_PATH = @abs_top_srcdir@/..
147147
148148 # The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of the
149149 # path mentioned in the documentation of a class, which tells the reader which
152152 # specify the list of include paths that are normally passed to the compiler
153153 # using the -I flag.
154154
155 STRIP_FROM_INC_PATH =
155 STRIP_FROM_INC_PATH = @abs_top_srcdir@/../include
156 STRIP_FROM_INC_PATH += @abs_top_srcdir@/../lib
156157
157158 # If the SHORT_NAMES tag is set to YES, doxygen will generate much shorter (but
158159 # less readable) file names. This can be useful is your file systems doesn't
512513 # files with double quotes in the documentation rather than with sharp brackets.
513514 # The default value is: NO.
514515
515 FORCE_LOCAL_INCLUDES = NO
516 FORCE_LOCAL_INCLUDES = YES
516517
517518 # If the INLINE_INFO tag is set to YES then a tag [inline] is inserted in the
518519 # documentation for inline members.
742743 # spaces.
743744 # Note: If this tag is empty the current directory is searched.
744745
745 INPUT = @abs_top_srcdir@/include \
746 @abs_top_srcdir@/lib \
747 @abs_top_srcdir@/docs/doxygen-mainpage.dox
746 INPUT = @abs_top_srcdir@/../include \
747 @abs_top_srcdir@/../lib \
748 @abs_top_srcdir@/doxygen-mainpage.dox
748749
749750 # This tag can be used to specify the character encoding of the source files
750751 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
812813 # that contain example code fragments that are included (see the \include
813814 # command).
814815
815 EXAMPLE_PATH = @abs_top_srcdir@/examples
816 EXAMPLE_PATH = @abs_top_srcdir@/../examples
816817
817818 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
818819 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
832833 # that contain images that are to be included in the documentation (see the
833834 # \image command).
834835
835 IMAGE_PATH = @abs_top_srcdir@/docs/img
836 IMAGE_PATH = @abs_top_srcdir@/img
836837
837838 # The INPUT_FILTER tag can be used to specify a program that doxygen should
838839 # invoke to filter for each input file. Doxygen will invoke the filter program