aboutsummaryrefslogtreecommitdiffstats
path: root/os/rt/src/chregistry.c
diff options
context:
space:
mode:
authorGiovanni Di Sirio <gdisirio@gmail.com>2016-02-24 15:30:26 +0000
committerGiovanni Di Sirio <gdisirio@gmail.com>2016-02-24 15:30:26 +0000
commit8faa787ebe7a161a1947afd0d37525cd99d6b141 (patch)
treefabc3ccc906d42941b7980449e27202ec1fc3766 /os/rt/src/chregistry.c
parent6d6284c9e6d1e3d1f0083c153ee21235771e1014 (diff)
downloadChibiOS-8faa787ebe7a161a1947afd0d37525cd99d6b141.tar.gz
ChibiOS-8faa787ebe7a161a1947afd0d37525cd99d6b141.tar.bz2
ChibiOS-8faa787ebe7a161a1947afd0d37525cd99d6b141.zip
git-svn-id: svn://svn.code.sf.net/p/chibios/svn/trunk@8942 35acf78f-673a-0410-8e92-d51de3d6d3f4
Diffstat (limited to 'os/rt/src/chregistry.c')
-rw-r--r--os/rt/src/chregistry.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/os/rt/src/chregistry.c b/os/rt/src/chregistry.c
index 7d870897b..ec90b4168 100644
--- a/os/rt/src/chregistry.c
+++ b/os/rt/src/chregistry.c
@@ -181,6 +181,9 @@ thread_t *chRegNextThread(thread_t *tp) {
/**
* @brief Retrieves a thread pointer by name.
+ * @note The reference counter of the found thread is increased by one so
+ * it cannot be disposed incidentally after the pointer has been
+ * returned.
*
* @param[in] name the thread name
* @return A pointer to the found thread.
@@ -205,6 +208,9 @@ thread_t *chRegFindThreadByName(const char *name) {
/**
* @brief Confirms that a pointer is a valid thread pointer.
+ * @note The reference counter of the found thread is increased by one so
+ * it cannot be disposed incidentally after the pointer has been
+ * returned.
*
* @param[in] tp pointer to the thread
* @return A pointer to the found thread.