From 3b54152563967557234838bf80a814012f7be903 Mon Sep 17 00:00:00 2001 From: Ryan Pavlik Date: Tue, 17 May 2022 16:58:36 -0500 Subject: [PATCH] auxiliary: Improve word choice/clarity --- src/xrt/auxiliary/ogl/ogl_documentation.h | 2 +- src/xrt/auxiliary/os/os_hid.h | 3 +-- src/xrt/auxiliary/os/os_time.h | 8 ++++---- src/xrt/auxiliary/vk/vk_bundle_init.c | 2 +- src/xrt/auxiliary/vk/vk_helpers.h | 6 +++--- 5 files changed, 10 insertions(+), 11 deletions(-) diff --git a/src/xrt/auxiliary/ogl/ogl_documentation.h b/src/xrt/auxiliary/ogl/ogl_documentation.h index 80abd6676..74d3f44c8 100644 --- a/src/xrt/auxiliary/ogl/ogl_documentation.h +++ b/src/xrt/auxiliary/ogl/ogl_documentation.h @@ -2,7 +2,7 @@ // SPDX-License-Identifier: BSL-1.0 /*! * @file - * @brief Header with just documentation. + * @brief Header with only documentation. * @author Jakob Bornecrantz * @ingroup aux_ogl */ diff --git a/src/xrt/auxiliary/os/os_hid.h b/src/xrt/auxiliary/os/os_hid.h index f30146879..1b4cbaab7 100644 --- a/src/xrt/auxiliary/os/os_hid.h +++ b/src/xrt/auxiliary/os/os_hid.h @@ -70,8 +70,7 @@ os_hid_write(struct os_hid_device *hid_dev, const uint8_t *data, size_t size) /*! * Get a numbered feature report. * - * If the device doesn't have more than one feature report, just request - * report 0. + * If the device doesn't have more than one feature report, request report 0. * * @public @memberof os_hid_device */ diff --git a/src/xrt/auxiliary/os/os_time.h b/src/xrt/auxiliary/os/os_time.h index e7ccd4007..6509d2483 100644 --- a/src/xrt/auxiliary/os/os_time.h +++ b/src/xrt/auxiliary/os/os_time.h @@ -125,7 +125,7 @@ os_precise_sleeper_deinit(struct os_precise_sleeper *ops) /*! * @brief Sleep the given number of nanoseconds, trying harder to be precise. * - * On some platforms, there is no way to improve sleep precision easily with some OS-specific state, so we just forward + * On some platforms, there is no way to improve sleep precision easily with some OS-specific state, so we forward * to os_nanosleep(). * * Note that on all platforms, the system scheduler has the final say. @@ -146,7 +146,7 @@ os_precise_sleeper_nanosleep(struct os_precise_sleeper *ops, int32_t nsec) } } #endif - // If we fall through from an implementation, or there's no implementation needed for a platform, we just + // If we fall through from an implementation, or there's no implementation needed for a platform, we // delegate to the regular os_nanosleep. os_nanosleep(nsec); } @@ -155,7 +155,7 @@ os_precise_sleeper_nanosleep(struct os_precise_sleeper *ops, int32_t nsec) /*! * @brief Convert a timespec struct to nanoseconds. * - * Note that this just does the value combining, no adjustment for epochs is performed. + * Note that this does the value combining, no adjustment for epochs is performed. * * @ingroup aux_os_time_extra */ @@ -171,7 +171,7 @@ os_timespec_to_ns(const struct timespec *spec) /*! * @brief Convert an nanosecond integer to a timespec struct. * - * Note that this just does the value splitting, no adjustment for epochs is performed. + * Note that this does the value splitting, no adjustment for epochs is performed. * @ingroup aux_os_time_extra */ static inline void diff --git a/src/xrt/auxiliary/vk/vk_bundle_init.c b/src/xrt/auxiliary/vk/vk_bundle_init.c index 42b41ab9a..a37e1a238 100644 --- a/src/xrt/auxiliary/vk/vk_bundle_init.c +++ b/src/xrt/auxiliary/vk/vk_bundle_init.c @@ -605,7 +605,7 @@ get_device_ext_props(struct vk_bundle *vk, res = vk->vkEnumerateDeviceExtensionProperties(physical_device, NULL, &prop_count, props); vk_check_error_with_free("vkEnumerateDeviceExtensionProperties", res, false, props); - // Check above returns on failure. + // The preceding check returns on failure. *out_props = props; *out_prop_count = prop_count; diff --git a/src/xrt/auxiliary/vk/vk_helpers.h b/src/xrt/auxiliary/vk/vk_helpers.h index f22ac01e1..935b6cfb5 100644 --- a/src/xrt/auxiliary/vk/vk_helpers.h +++ b/src/xrt/auxiliary/vk/vk_helpers.h @@ -39,8 +39,8 @@ extern "C" { /*! * A bundle of Vulkan functions and objects, used by both @ref comp and @ref - * comp_client. Note that they both have different instances of the object and - * as such VkInstance and so on. + * comp_client. Note that they both have different instances of the object, and + * thus different VkInstance, etc. * * @ingroup aux_vk */ @@ -871,7 +871,7 @@ VkResult vk_locked_submit(struct vk_bundle *vk, VkQueue queue, uint32_t count, const VkSubmitInfo *infos, VkFence fence); /*! - * Set the image layout via a berrier command, takes the pool lock. + * Set the image layout using a barrier command, takes the pool lock. * * @pre Requires successful call to vk_init_mutex. *