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 2757a1ea317578c42d8dc58f4f724e4a38c1a1a1..6f2083e1c67d503a8be770b1751a4f0f6b8bfdae 100644 (file)
--- 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,