[cadcdev-svn-commits] [SCM] branch master updated. v2.0.0-1384-g8493f97e

[darcagn <da...@us...>]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "A pseudo Operating System for the Dreamcast.".

The branch, master has been updated
       via  8493f97e5570ce1fcb5c9a16a8fab466e034b339 (commit)
      from  4fde7cc16056bd59fb34ce6aaef8c84268fae0c5 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit 8493f97e5570ce1fcb5c9a16a8fab466e034b339
Author: Falco Girgis <gyr...@gm...>
Date:   Thu May 9 22:28:27 2024 -0500

    Teensy Doxygen fix for worker_thread.h. (#563)
    
    - Apparently Doxygen can't figure out opaque structures without
      explicitly marking them with the \struct tag.
    - Misnamed parameter for thd_worker_dequeue_job().

-----------------------------------------------------------------------

Summary of changes:
 include/kos/worker_thread.h | 7 +++----
 1 file changed, 3 insertions(+), 4 deletions(-)

diff --git a/include/kos/worker_thread.h b/include/kos/worker_thread.h
index 2ec940e8..0d291897 100644
--- a/include/kos/worker_thread.h
+++ b/include/kos/worker_thread.h
@@ -37,9 +37,8 @@ __BEGIN_DECLS
 
 struct kthread_worker;
 
-/** \brief   Structure describing one worker thread.
-
-    \headerfile kos/thread.h
+/** \struct  kthread_worker_t
+    \brief   Opaque structure describing one worker thread.
 */
 typedef struct kthread_worker kthread_worker_t;
 
@@ -145,7 +144,7 @@ void thd_worker_add_job(kthread_worker_t *thd, kthread_job_t *job);
     previously queued using thd_worker_add_job(). This function is typically
     used inside the work function registered with thd_worker_create().
 
-    \param  thd             The worker thread to add a job to.
+    \param  worker          The worker thread to add a job to.
 
     \return                 A new job to process, or NULL if there is none.
 */


hooks/post-receive
-- 
A pseudo Operating System for the Dreamcast.