Skip to content

Commit 94c0af5

Browse files
committedJan 21, 2017
Changed doxygen destination and added mainpage
1 parent 347eea0 commit 94c0af5

File tree

2 files changed

+43
-17
lines changed

2 files changed

+43
-17
lines changed
 

‎Doxyfile

+32-17
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Doxyfile 1.8.12
1+
# Doxyfile 1.8.11
22

33
# This file describes the settings to be used by the documentation system
44
# doxygen (www.doxygen.org) for a project.
@@ -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 = doc
61+
OUTPUT_DIRECTORY = generated-doc
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
@@ -303,15 +303,6 @@ EXTENSION_MAPPING =
303303

304304
MARKDOWN_SUPPORT = YES
305305

306-
# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up
307-
# to that level are automatically included in the table of contents, even if
308-
# they do not have an id attribute.
309-
# Note: This feature currently applies only to Markdown headings.
310-
# Minimum value: 0, maximum value: 99, default value: 0.
311-
# This tag requires that the tag MARKDOWN_SUPPORT is set to YES.
312-
313-
TOC_INCLUDE_HEADINGS = 0
314-
315306
# When enabled doxygen tries to link words that correspond to documented
316307
# classes, or namespaces to their corresponding documentation. Such a link can
317308
# be prevented in individual cases by putting a % sign in front of the word or
@@ -790,7 +781,9 @@ WARN_LOGFILE =
790781
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
791782
# Note: If this tag is empty the current directory is searched.
792783

793-
INPUT = /home/jgaa/src/restc-cpp/include/restc-cpp
784+
INPUT = /home/jgaa/src/restc-cpp/include/restc-cpp \
785+
/home/jgaa/src/restc-cpp/ \
786+
/home/jgaa/src/restc-cpp/doc
794787

795788
# This tag can be used to specify the character encoding of the source files
796789
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -812,8 +805,8 @@ INPUT_ENCODING = UTF-8
812805
# If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp,
813806
# *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h,
814807
# *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc,
815-
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
816-
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
808+
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl,
809+
# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js.
817810

818811
FILE_PATTERNS = *.c \
819812
*.cc \
@@ -858,7 +851,8 @@ FILE_PATTERNS = *.c \
858851
*.vhd \
859852
*.vhdl \
860853
*.ucf \
861-
*.qsf
854+
*.qsf \
855+
*.md
862856

863857
# The RECURSIVE tag can be used to specify whether or not subdirectories should
864858
# be searched for input files as well.
@@ -1070,6 +1064,25 @@ USE_HTAGS = NO
10701064

10711065
VERBATIM_HEADERS = YES
10721066

1067+
# If the CLANG_ASSISTED_PARSING tag is set to YES then doxygen will use the
1068+
# clang parser (see: http://clang.llvm.org/) for more accurate parsing at the
1069+
# cost of reduced performance. This can be particularly helpful with template
1070+
# rich C++ code for which doxygen's built-in parser lacks the necessary type
1071+
# information.
1072+
# Note: The availability of this option depends on whether or not doxygen was
1073+
# generated with the -Duse-libclang=ON option for CMake.
1074+
# The default value is: NO.
1075+
1076+
CLANG_ASSISTED_PARSING = NO
1077+
1078+
# If clang assisted parsing is enabled you can provide the compiler with command
1079+
# line options that you would normally use when invoking the compiler. Note that
1080+
# the include paths will already be set by doxygen for the files and directories
1081+
# specified with INPUT and INCLUDE_PATH.
1082+
# This tag requires that the tag CLANG_ASSISTED_PARSING is set to YES.
1083+
1084+
CLANG_OPTIONS =
1085+
10731086
#---------------------------------------------------------------------------
10741087
# Configuration options related to the alphabetical class index
10751088
#---------------------------------------------------------------------------
@@ -2193,7 +2206,7 @@ HIDE_UNDOC_RELATIONS = YES
21932206
# http://www.graphviz.org/), a graph visualization toolkit from AT&T and Lucent
21942207
# Bell Labs. The other options in this section have no effect if this option is
21952208
# set to NO
2196-
# The default value is: NO.
2209+
# The default value is: YES.
21972210

21982211
HAVE_DOT = YES
21992212

@@ -2349,7 +2362,9 @@ DIRECTORY_GRAPH = YES
23492362
# Note: If you choose svg you need to set HTML_FILE_EXTENSION to xhtml in order
23502363
# to make the SVG files visible in IE 9+ (other browsers do not have this
23512364
# requirement).
2352-
# Possible values are: png, jpg, gif, svg, png:gd, png:gd:gd, png:cairo,
2365+
# Possible values are: png, png:cairo, png:cairo:cairo, png:cairo:gd, png:gd,
2366+
# png:gd:gd, jpg, jpg:cairo, jpg:cairo:gd, jpg:gd, jpg:gd:gd, gif, gif:cairo,
2367+
# gif:cairo:gd, gif:gd, gif:gd:gd, svg, png:gd, png:gd:gd, png:cairo,
23532368
# png:cairo:gd, png:cairo:cairo, png:cairo:gdiplus, png:gdiplus and
23542369
# png:gdiplus:gdiplus.
23552370
# The default value is: png.

‎doc/doxygen-mainpage.md

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
@mainpage
2+
3+
# Taking the pain out of REST in C++
4+
5+
- @ref README.md
6+
- @ref doc/GettingStarted.md
7+
- @ref doc/Tutorial.md
8+
- @ref doc/RunningTheTests.md
9+
10+
Home page: https://github.com/jgaa/restc-cpp
11+

0 commit comments

Comments
 (0)