From 6c6c0c21641d581c9312463b7f361df66945c76b Mon Sep 17 00:00:00 2001 From: Dave Abrahams Date: Thu, 24 Oct 2024 18:08:27 -0700 Subject: [PATCH] Fix markdown in README doc comments Blank line is needed after summary paragraph. --- README.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/README.md b/README.md index 473cd64..d55ecc0 100644 --- a/README.md +++ b/README.md @@ -172,6 +172,7 @@ For example, #include /// A half-open range of integers. +/// /// - Invariant: start() <= end(). class int_range { /// The lower bound; if `*this` is non-empty, its @@ -185,6 +186,7 @@ class int_range { bool is_valid() const { return start() <= end(); } public: /// An instance with the given bounds. + /// /// - Precondition: `end >= start`. int_range(int start, int end) : _start(start), _end(end) { ADOBE_PRECONDITION(end >= start, "invalid range bounds."); @@ -200,6 +202,7 @@ public: int end() const { return _end; } /// Increases the upper bound by 1. + /// /// - Precondition: `end() < INT_MAX`. void grow_rightward() { ADOBE_PRECONDITION(end() < INT_MAX);