# HG changeset patch
# User Sebastien Jodogne <s.jodogne@gmail.com>
# Date 1702930905 -3600
# Node ID 2c23bb7d50ceaf4351592837bb92435833d5c551
# Parent  1dc6e4b7f5d82aa8737938f2de14a5a71e5290f2
review doc of OrthancPluginSetCurrentThreadName()

diff -r 1dc6e4b7f5d8 -r 2c23bb7d50ce OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h
--- a/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h	Mon Dec 18 21:15:42 2023 +0100
+++ b/OrthancServer/Plugins/Include/orthanc/OrthancCPlugin.h	Mon Dec 18 21:21:45 2023 +0100
@@ -9358,21 +9358,22 @@
   }
 
 
-/**
-   * @brief Sets the name of the current thread
-   *
-   * This function sets the name of the thread that is calling it.
-   * This name is used in the logs.  This function shall be called only from threads that
-   * the plugin has created itself.
-   * 
-   * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
-   * @param threadName The name of the current thread.  A Thread name can not be larger than 16 characters.
+  /**
+   * @brief Set the name of the current thread.
+   *
+   * This function gives a name to the thread that is calling this
+   * function. This name is used in the Orthanc logs. This function
+   * must only be called from threads that the plugin has created
+   * itself.
+   *
+   * @param context The Orthanc plugin context, as received by OrthancPluginInitialize().
+   * @param threadName The name of the current thread. A thread name cannot be longer than 16 characters.
    * @return 0 if success, other value if error.
    * @ingroup Toolbox
    **/
   ORTHANC_PLUGIN_INLINE OrthancPluginErrorCode OrthancPluginSetCurrentThreadName(
-    OrthancPluginContext*                        context,
-    const char*                                  threadName)
+    OrthancPluginContext*  context,
+    const char*            threadName)
   {
     return context->InvokeService(context, _OrthancPluginService_SetCurrentThreadName, threadName);
   }