add a note for svcExitThread and the thread API

Calling svcExitThread will make it so that threadCreate detached parameter won't work.

diff --git a/libctru/include/3ds/thread.h b/libctru/include/3ds/thread.h
index a92b46ff9d0c3d6838ff972ba41268fdab1df865..69998a22aae1df68918c27d969aa62909044942b 100644 (file)
--- a/libctru/include/3ds/thread.h
+++ b/libctru/include/3ds/thread.h
@@ -31,6 +31,9 @@ typedef struct Thread_tag* Thread;
  * - Processor #2 is New3DS exclusive. Normal applications can create threads on this core if the exheader kernel flags bitmask has 0x2000 set.
  * - Processor #3 is New3DS exclusive. Normal applications cannot create threads on this core.
  * - Processes in the BASE memory region can always create threads on processors #2 and #3.
+ *
+ * @note Default exit code of a thread is 0.
+ * @warning @ref svcExitThread should never be called from the thread, use @ref threadExit instead.
  */
 Thread threadCreate(ThreadFunc entrypoint, void* arg, size_t stack_size, int prio, int affinity, bool detached);