From b5235c92ac4aee8ef2655ffebb3bcb9357a8cc45 Mon Sep 17 00:00:00 2001 From: Jason Felds Date: Sun, 27 Feb 2011 20:41:27 -0500 Subject: [PATCH] Can't forget doxy'ing some arch stuff. --- src/archutils/Darwin/DarwinThreadHelpers.h | 24 +++++++++++++++++++--- 1 file changed, 21 insertions(+), 3 deletions(-) diff --git a/src/archutils/Darwin/DarwinThreadHelpers.h b/src/archutils/Darwin/DarwinThreadHelpers.h index ac8dfbe2c4..e697cb9536 100644 --- a/src/archutils/Darwin/DarwinThreadHelpers.h +++ b/src/archutils/Darwin/DarwinThreadHelpers.h @@ -1,16 +1,34 @@ #ifndef DARWIN_THREAD_HELPERS_H #define DARWIN_THREAD_HELPERS_H +/** + * @brief Attempt to suspend the specified thread. + * @param threadHandle the thread to suspend. + * @return true if the thread is suspended, false otherwise. */ bool SuspendThread( uint64_t threadHandle ); +/** + * @brief Attempt to resume the specified thread. + * @param threadHandle the thread to resume. + * @return true if the thread is resumed, false otherwise. */ bool ResumeThread( uint64_t threadHandle ); +/** + * @brief Retrieve the current thread ID. + * @return the current thread ID. */ uint64_t GetCurrentThreadId(); -// Valid values are from 0.0f to 1.0f. 0.5f is default. +/** + * @brief Set the precedence for the thread. + * + * Valid values for the thread are from 0.0f to 1.0f. + * 0.5f is the default. + * @param prec the precedence to set. */ RString SetThreadPrecedence( float prec ); #endif -/* - * (c) 2004-2006 Steve Checkoway +/** + * @file + * @author Steve Checkoway (c) 2004-2006 + * @section LICENSE * All rights reserved. * * Permission is hereby granted, free of charge, to any person obtaining a