From f10c0aae21202f2f0e0625abc7982054e926ec4d Mon Sep 17 00:00:00 2001
From: Klemens Morgenstern <klemens.d.morgenstern@gmail.com>
Date: Tue, 11 Oct 2022 23:37:26 +0800
Subject: [PATCH] api version is documented in the docs

Closes #298
---
 doc/qbk/main.qbk                |  2 ++
 doc/qbk/version.qbk             | 21 +++++++++++++++++++++
 include/boost/beast/version.hpp | 13 ++++++++-----
 3 files changed, 31 insertions(+), 5 deletions(-)
 create mode 100644 doc/qbk/version.qbk

diff --git a/doc/qbk/main.qbk b/doc/qbk/main.qbk
index eb346fe9..32cf6d9b 100644
--- a/doc/qbk/main.qbk
+++ b/doc/qbk/main.qbk
@@ -164,6 +164,7 @@
 [import ../../test/doc/websocket_8_notes.cpp]
 
 [import ../../include/boost/beast/core/detect_ssl.hpp]
+[import ../../include/boost/beast/version.hpp]
 [import ../../test/beast/core/rate_policy.cpp]
 
 __new__ indicates a new or updated section in this version.
@@ -185,6 +186,7 @@ __new__ indicates an item that was recently added.
 [block'''</reference>''']
 
 [include release_notes.qbk]
+[include version.qbk]
 
 [include 01_intro/_intro.qbk]
 [include 02_examples/_examples.qbk]
diff --git a/doc/qbk/version.qbk b/doc/qbk/version.qbk
new file mode 100644
index 00000000..29c9e9ef
--- /dev/null
+++ b/doc/qbk/version.qbk
@@ -0,0 +1,21 @@
+ [/
+    Copyright (c) 2022 Klemens D. Morgenstern (klemens dot morgenstern at gmx dot net)
+
+    Distributed under the Boost Software License, Version 1.0. (See accompanying
+    file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)
+
+    Official repository: https://github.com/boostorg/beast
+]
+
+[section Beast API Version]
+
+Beast maintains it's own API version, which is more fine-grained than the
+boost release.
+
+It can be obtained as a string from the `BOOST_BEAST_VERSION` macro 
+or a string through `BOOST_BEAST_VERSION_STRING`.
+
+[version]
+
+
+[endsect]
diff --git a/include/boost/beast/version.hpp b/include/boost/beast/version.hpp
index a59acb70..eb2d2bab 100644
--- a/include/boost/beast/version.hpp
+++ b/include/boost/beast/version.hpp
@@ -13,16 +13,19 @@
 #include <boost/beast/core/detail/config.hpp>
 #include <boost/config.hpp>
 
-/*  BOOST_BEAST_VERSION
+//[version
 
-    Identifies the API version of Beast.
+/* Identifies the API version of Beast.
 
-    This is a simple integer that is incremented by one every
-    time a set of code changes is merged to the develop branch.
+   This is a simple integer that is incremented by one every
+   time a set of code changes is merged to the develop branch.
 */
-#define BOOST_BEAST_VERSION 336
+#define BOOST_BEAST_VERSION 339
 
+// A string describing BOOST_BEAST_VERSION, that can be used in http headers.
 #define BOOST_BEAST_VERSION_STRING "Boost.Beast/" BOOST_STRINGIZE(BOOST_BEAST_VERSION)
 
+//]
+
 #endif