From: telleriam <telleriam@35b4ef3e-fd22-0410-ab77-dab3279adceb>
Date: Fri, 15 May 2009 14:32:30 +0000 (+0000)
Subject: Adding more comments to a function description
X-Git-Url: https://rtime.felk.cvut.cz/gitweb/frescor/frsh-include.git/commitdiff_plain/6094090fc82e2543592957af91d50a7596154ec0

Adding more comments to a function description



git-svn-id: http://www.frescor.org/private/svn/frescor/frsh/trunk/include@1741 35b4ef3e-fd22-0410-ab77-dab3279adceb
---

diff --git a/frsh_core.h b/frsh_core.h
index 2757a1e..6f2083e 100644
--- a/frsh_core.h
+++ b/frsh_core.h
@@ -872,6 +872,10 @@ int frsh_thread_create_in_background
  *
  * @param[out] vres_id:      Resulting vres_id from the on-the-fly
  *                           generated background contract.
+ *
+ * @return  0 if successful\n
+ *          FRSH_ERR_NOT_CONTRACTED_VRES if the thread is already
+ *          bound to a vres.
  **/
 int frsh_thread_join_in_background(frsh_resource_id_t resource_id,
                                    frsh_resource_type_t resource_type,