Skip to content

Commit

Permalink
Doc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
anarthal committed Oct 3, 2023
1 parent be20c0d commit ecfe51c
Showing 1 changed file with 6 additions and 4 deletions.
10 changes: 6 additions & 4 deletions doc/Jamfile
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ import sequence ;

# All paths must be absolute to work well with the Doxygen rules.
path-constant this_dir : . ;
path-constant redis_root_dir : .. ;
path-constant include_dir : ../include ;
path-constant examples_dir : ../examples ;
path-constant readme : ../README.md ;
Expand All @@ -17,7 +18,7 @@ local examples = [ path.glob-tree $(examples_dir) : *.hpp *.cpp ] ;

# If passed directly, several HTML_EXTRA_STYLESHEET tags are generated,
# which is not correct.
local stylesheet_arg = [ sequence.join $(stylesheet_files) : " " ] ;
local stylesheet_arg = [ sequence.join "\"$(stylesheet_files)\"" : " " ] ;

doxygen autodoc.html
:
Expand All @@ -26,6 +27,8 @@ doxygen autodoc.html
<doxygen:param>PROJECT_NAME=boost_redis
<doxygen:param>PROJECT_NUMBER="1.4.2"
<doxygen:param>PROJECT_BRIEF="A redis client library"
<doxygen:param>"STRIP_FROM_PATH=\"$(redis_root_dir)\""
<doxygen:param>"STRIP_FROM_INC_PATH=\"$(include_dir)\""
<doxygen:param>BUILTIN_STL_SUPPORT=YES
<doxygen:param>INLINE_SIMPLE_STRUCTS=YES
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
Expand All @@ -35,11 +38,11 @@ doxygen autodoc.html
<doxygen:param>SORT_MEMBERS_CTORS_1ST=YES
<doxygen:param>SHOW_FILES=NO
<doxygen:param>SHOW_NAMESPACES=NO
<doxygen:param>LAYOUT_FILE=$(layout_file)
<doxygen:param>"LAYOUT_FILE=\"$(layout_file)\""
<doxygen:param>WARN_IF_INCOMPLETE_DOC=YES
<doxygen:param>FILE_PATTERNS="*.hpp *.cpp"
<doxygen:param>EXCLUDE_SYMBOLS=std
<doxygen:param>USE_MDFILE_AS_MAINPAGE=$(readme)
<doxygen:param>"USE_MDFILE_AS_MAINPAGE=\"$(readme)\""
<doxygen:param>SOURCE_BROWSER=YES
<doxygen:param>"HTML_EXTRA_STYLESHEET=$(stylesheet_arg)"
<doxygen:param>HTML_TIMESTAMP=YES
Expand All @@ -50,7 +53,6 @@ doxygen autodoc.html
<doxygen:param>USE_MATHJAX=YES
<doxygen:param>MATHJAX_VERSION=MathJax_2
<doxygen:param>MATHJAX_RELPATH="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/"
<doxygen:param>GENERATE_LATEX=NO
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>HAVE_DOT=NO
<doxygen:param>CLASS_GRAPH=NO
Expand Down

0 comments on commit ecfe51c

Please sign in to comment.