rthreads: Fix documentation (void function doesn’t return)

linkmauve · linkmauve · commit 3b37591a7b04 · 2020-09-01T00:28:01.000+02:00
diff --git a/include/rthreads/rthreads.h b/include/rthreads/rthreads.h
@@ -90,8 +90,6 @@ int sthread_detach(sthread_t *thread);
  * @thread to terminate. If that thread has already terminated, then
  * it will return immediately. The thread specified by @thread must
  * be joinable.
- *
- * Returns: 0 on success, otherwise it returns a non-zero error number.
  */
 void sthread_join(sthread_t *thread);
 
diff --git a/rthreads/rthreads.c b/rthreads/rthreads.c
@@ -285,8 +285,6 @@ int sthread_detach(sthread_t *thread)
  * @thread to terminate. If that thread has already terminated, then
  * it will return immediately. The thread specified by @thread must
  * be joinable.
- *
- * Returns: 0 on success, otherwise it returns a non-zero error number.
  */
 void sthread_join(sthread_t *thread)
 {

Original file line number	Diff line number	Diff line change
`@@ -285,8 +285,6 @@ int sthread_detach(sthread_t *thread)`
`285`	`285`	`* @thread to terminate. If that thread has already terminated, then`
`286`	`286`	`* it will return immediately. The thread specified by @thread must`
`287`	`287`	`* be joinable.`
`288`		`- *`
`289`		`- * Returns: 0 on success, otherwise it returns a non-zero error number.`
`290`	`288`	`*/`
`291`	`289`	`void sthread_join(sthread_t *thread)`
`292`	`290`	`{`