diff --git a/doc/Jamfile b/doc/Jamfile new file mode 100644 index 00000000..f18ccdae --- /dev/null +++ b/doc/Jamfile @@ -0,0 +1,67 @@ +project redis/doc ; + +import doxygen ; +import path ; +import sequence ; + +# All paths must be absolute to work well with the Doxygen rules. +path-constant this_dir : . ; +path-constant include_dir : ../include ; +path-constant examples_dir : ../examples ; +path-constant readme : ../README.md ; +path-constant layout_file : DoxygenLayout.xml ; + +local stylesheet_files = [ path.glob $(this_dir) : *.css ] ; +local includes = [ path.glob-tree $(include_dir) : *.hpp *.cpp ] ; +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) : " " ] ; + +doxygen autodoc.html + : + $(includes) $(examples) $(readme) + : + PROJECT_NAME=boost_redis + PROJECT_NUMBER="1.4.2" + PROJECT_BRIEF="A redis client library" + BUILTIN_STL_SUPPORT=YES + INLINE_SIMPLE_STRUCTS=YES + HIDE_UNDOC_MEMBERS=YES + HIDE_UNDOC_CLASSES=YES + SHOW_HEADERFILE=YES + SORT_BRIEF_DOCS=YES + SORT_MEMBERS_CTORS_1ST=YES + SHOW_FILES=NO + SHOW_NAMESPACES=NO + LAYOUT_FILE=$(layout_file) + WARN_IF_INCOMPLETE_DOC=YES + FILE_PATTERNS="*.hpp *.cpp" + EXCLUDE_SYMBOLS=std + USE_MDFILE_AS_MAINPAGE=$(readme) + SOURCE_BROWSER=YES + "HTML_EXTRA_STYLESHEET=$(stylesheet_arg)" + HTML_TIMESTAMP=YES + GENERATE_TREEVIEW=YES + FULL_SIDEBAR=NO + ENUM_VALUES_PER_LINE=0 + OBFUSCATE_EMAILS=YES + USE_MATHJAX=YES + MATHJAX_VERSION=MathJax_2 + MATHJAX_RELPATH="https://cdnjs.cloudflare.com/ajax/libs/mathjax/2.7.5/" + GENERATE_LATEX=NO + MACRO_EXPANSION=YES + HAVE_DOT=NO + CLASS_GRAPH=NO + DIRECTORY_GRAPH=NO + ; + +# These are used to inform the build system of the +# means to build the integrated and stand-alone docs. + +alias boostdoc ; +explicit boostdoc ; + +alias boostrelease : autodoc.html ; +explicit boostrelease ; diff --git a/include/boost/redis/connection.hpp b/include/boost/redis/connection.hpp index 0b0c6267..7e68475e 100644 --- a/include/boost/redis/connection.hpp +++ b/include/boost/redis/connection.hpp @@ -171,7 +171,6 @@ public: * To cancel an ongoing receive operation apps should call * `connection::cancel(operation::receive)`. * - * @param response Response object. * @param token Completion token. * * For an example see cpp20_subscriber.cpp. The completion token must @@ -264,7 +263,6 @@ public: * @li operation::all: Cancels all operations listed above. * * @param op: The operation to be cancelled. - * @returns The number of operations that have been canceled. */ void cancel(operation op = operation::all) { diff --git a/include/boost/redis/logger.hpp b/include/boost/redis/logger.hpp index b7c1e09c..41d8e18a 100644 --- a/include/boost/redis/logger.hpp +++ b/include/boost/redis/logger.hpp @@ -117,8 +117,8 @@ public: /** @brief Called when the run operation completes. * @ingroup high-level-api * - * @param read_ec Error code returned by the read operation. - * @param write_ec Error code returned by the write operation. + * @param reader_ec Error code returned by the read operation. + * @param writer_ec Error code returned by the write operation. */ void on_run(system::error_code const& reader_ec, system::error_code const& writer_ec); diff --git a/include/boost/redis/response.hpp b/include/boost/redis/response.hpp index b3f76ad5..326012db 100644 --- a/include/boost/redis/response.hpp +++ b/include/boost/redis/response.hpp @@ -54,7 +54,7 @@ using generic_response = adapter::result>; * std::cout << "PING: " << resp.value().front().value << std::endl; * consume_one(resp); * std::cout << "PING: " << resp.value().front().value << std::endl; - * @code + * @endcode * * is * @@ -62,7 +62,7 @@ using generic_response = adapter::result>; * PING: one * PING: two * PING: three - * @code + * @endcode * * Given that this function rotates elements, it won't be very * efficient for responses with a large number of elements. It was