diff options
| author | Keir Mierle <keir@google.com> | 2020-03-03 10:27:01 -0800 |
|---|---|---|
| committer | CQ Bot Account <commit-bot@chromium.org> | 2020-03-03 19:38:56 +0000 |
| commit | ec9bf1bf3aa849750b615e31395ed974f42ed7e8 (patch) | |
| tree | 76b8e6558ee97ada0ee69fd0a74b93755beb2fa7 /pw_assert_basic | |
| parent | 4a257c1bc592f355c4a9bb712c322d1a45cacfb8 (diff) | |
| download | pigweed-ec9bf1bf3aa849750b615e31395ed974f42ed7e8.tar.gz | |
pw_assert: Expand documentation coverage
Change-Id: Ic3f57f30286ca96fb6d0bc303de39c60322ea663
Diffstat (limited to 'pw_assert_basic')
| -rw-r--r-- | pw_assert_basic/BUILD.gn | 6 | ||||
| -rw-r--r-- | pw_assert_basic/docs.rst | 15 |
2 files changed, 21 insertions, 0 deletions
diff --git a/pw_assert_basic/BUILD.gn b/pw_assert_basic/BUILD.gn index 9b39a97f8..091a09598 100644 --- a/pw_assert_basic/BUILD.gn +++ b/pw_assert_basic/BUILD.gn @@ -12,6 +12,8 @@ # License for the specific language governing permissions and limitations under # the License. +import("$dir_pw_docgen/docs.gni") + config("default_config") { include_dirs = [ "public" ] } @@ -43,3 +45,7 @@ source_set("core") { public = [ "public/pw_assert_basic/assert_basic.h" ] sources = public + [ "assert_basic.cc" ] } + +pw_doc_group("docs") { + sources = [ "docs.rst" ] +} diff --git a/pw_assert_basic/docs.rst b/pw_assert_basic/docs.rst new file mode 100644 index 000000000..c930b7914 --- /dev/null +++ b/pw_assert_basic/docs.rst @@ -0,0 +1,15 @@ +.. _chapter-pw-assert-basic: + +.. default-domain:: cpp + +.. highlight:: cpp + +=============== +pw_assert_basic +=============== + +-------- +Overview +-------- +This is a simple assert backend to complement the ``pw_assert`` facade. + |