diff options
| author | Kayce Basques <kayce@google.com> | 2023-06-16 23:49:44 +0000 |
|---|---|---|
| committer | CQ Bot Account <pigweed-scoped@luci-project-accounts.iam.gserviceaccount.com> | 2023-06-16 23:49:44 +0000 |
| commit | 410b336e17210a0c57e10712fc2ee385c7c9e030 (patch) | |
| tree | 52949f1d9553b2eafe358505686dea9e8b2a7745 /pw_sys_io | |
| parent | 9d591f9bf166145d48f070316bf0d5fb72e4c2de (diff) | |
| download | pigweed-410b336e17210a0c57e10712fc2ee385c7c9e030.tar.gz | |
pw_sys_io: Doxygenify ReadByte()
Change-Id: I7c0154f7310531bb607c1fbe6b3fab59d2e6e654
Reviewed-on: https://pigweed-review.googlesource.com/c/pigweed/pigweed/+/152075
Reviewed-by: Wyatt Hepler <hepler@google.com>
Pigweed-Auto-Submit: Kayce Basques <kayce@google.com>
Reviewed-by: Kayce Basques <kayce@google.com>
Commit-Queue: Kayce Basques <kayce@google.com>
Diffstat (limited to 'pw_sys_io')
| -rw-r--r-- | pw_sys_io/docs.rst | 4 | ||||
| -rw-r--r-- | pw_sys_io/public/pw_sys_io/sys_io.h | 19 |
2 files changed, 15 insertions, 8 deletions
diff --git a/pw_sys_io/docs.rst b/pw_sys_io/docs.rst index eaf60ba92..dbea7fbfa 100644 --- a/pw_sys_io/docs.rst +++ b/pw_sys_io/docs.rst @@ -39,6 +39,10 @@ Module usage See backend docs for how to interact with the underlying system I/O implementation. +API reference +============= +.. doxygenfunction:: pw::sys_io::ReadByte(std::byte* dest) + Dependencies ============ * pw_sys_io_backend diff --git a/pw_sys_io/public/pw_sys_io/sys_io.h b/pw_sys_io/public/pw_sys_io/sys_io.h index 2e9f663ff..5346138eb 100644 --- a/pw_sys_io/public/pw_sys_io/sys_io.h +++ b/pw_sys_io/public/pw_sys_io/sys_io.h @@ -45,14 +45,17 @@ namespace pw::sys_io { -// Read a single byte from the sys io backend. -// Implemented by: Backend -// -// This function will block until it either succeeds or fails to read a byte -// from the pw_sys_io backend. -// -// Returns OkStatus() - A byte was successfully read. -// Status::ResourceExhausted() - if the underlying source vanished. +/// Reads a single byte from the `pw_sys_io` backend. +/// This function blocks until it either succeeds or fails to read a +/// byte. +/// +/// @pre This function must be implemented by the `pw_sys_io` backend. +/// +/// @warning Do not build production projects on top of `pw_sys_io`. +/// +/// @returns +/// * @pw_status{OK} - A byte was successfully read. +/// * @pw_status{RESOURCE_EXHAUSTED} - The underlying source vanished. Status ReadByte(std::byte* dest); // Read a single byte from the sys io backend, if available. |