Docs via b2

Author: anarthal

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)
+    :
+        <doxygen:param>PROJECT_NAME=boost_redis
+        <doxygen:param>PROJECT_NUMBER="1.4.2"
+        <doxygen:param>PROJECT_BRIEF="A redis client library"
+        <doxygen:param>BUILTIN_STL_SUPPORT=YES
+        <doxygen:param>INLINE_SIMPLE_STRUCTS=YES
+        <doxygen:param>HIDE_UNDOC_MEMBERS=YES
+        <doxygen:param>HIDE_UNDOC_CLASSES=YES
+        <doxygen:param>SHOW_HEADERFILE=YES
+        <doxygen:param>SORT_BRIEF_DOCS=YES
+        <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>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>SOURCE_BROWSER=YES
+        <doxygen:param>"HTML_EXTRA_STYLESHEET=$(stylesheet_arg)"
+        <doxygen:param>HTML_TIMESTAMP=YES
+        <doxygen:param>GENERATE_TREEVIEW=YES
+        <doxygen:param>FULL_SIDEBAR=NO
+        <doxygen:param>ENUM_VALUES_PER_LINE=0
+        <doxygen:param>OBFUSCATE_EMAILS=YES
+        <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
+        <doxygen:param>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 ;

include/boost/redis/connection.hpp

@@ -171,7 +171,6 @@ class basic_connection {
     *  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 @@ class basic_connection {
     *  @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)
    {

include/boost/redis/logger.hpp

@@ -117,8 +117,8 @@ class logger {
    /** @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);
 

include/boost/redis/response.hpp

@@ -54,15 +54,15 @@ using generic_response = adapter::result<std::vector<resp3::node>>;
  * std::cout << "PING: " << resp.value().front().value << std::endl;
  * consume_one(resp);
  * std::cout << "PING: " << resp.value().front().value << std::endl;
- * @code
+ * @endcode
  *
  * is
  *
  * @code
  * 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