diff options
| author | levlam <levlam@telegram.org> | 2021-05-20 18:30:46 +0300 |
|---|---|---|
| committer | levlam <levlam@telegram.org> | 2021-05-20 18:30:46 +0300 |
| commit | 65c3c89ad6bb9f1aadf27bb2ae5997fee5ab3eae (patch) | |
| tree | cb00e67bd09a88c0db3944ac5546da3f4991e7e1 | |
| parent | 3f9b3046a67ae9bf2a07d8f6c4f5c254e545f2d8 (diff) | |
Improve LogMessageCallbackPtr documentation.
| -rw-r--r-- | format.ps1 | 2 | ||||
| -rw-r--r-- | td/telegram/Client.h | 5 | ||||
| -rw-r--r-- | td/telegram/ClientDotNet.cpp | 5 | ||||
| -rw-r--r-- | td/telegram/td_json_client.h | 5 |
4 files changed, 10 insertions, 7 deletions
diff --git a/format.ps1 b/format.ps1 index f64296cc3..3f482557c 100644 --- a/format.ps1 +++ b/format.ps1 @@ -1,3 +1,3 @@ -./src.ps1 | Select-String -NotMatch "CxCli.h" | Select-String -NotMatch "dotnet" | ForEach-Object { +./src.ps1 | Select-String -NotMatch "CxCli.h" | Select-String -NotMatch "DotNet" | ForEach-Object { clang-format -verbose -style=file -i $_ } diff --git a/td/telegram/Client.h b/td/telegram/Client.h index b61dc60d9..d54b1e377 100644 --- a/td/telegram/Client.h +++ b/td/telegram/Client.h @@ -241,8 +241,9 @@ class ClientManager final { /** * A type of callback function that will be called when a message is added to the internal TDLib log. * - * \param verbosity_level Log verbosity level with which the message was added. If 0, then TDLib will crash - * as soon as the callback returns. + * \param verbosity_level Log verbosity level with which the message was added (-1 - 1024). + * If 0, then TDLib will crash as soon as the callback returns. + * None of the TDLib methods can be called from the callback. * \param message Null-terminated string with the message added to the log. */ using LogMessageCallbackPtr = void (*)(int verbosity_level, const char *message); diff --git a/td/telegram/ClientDotNet.cpp b/td/telegram/ClientDotNet.cpp index 37eb34a9b..0ea8742e0 100644 --- a/td/telegram/ClientDotNet.cpp +++ b/td/telegram/ClientDotNet.cpp @@ -25,8 +25,9 @@ using namespace CxCli; /// <summary> /// A type of callback function that will be called when a message is added to the internal TDLib log. /// </summary> -/// <param name="verbosityLevel">Log verbosity level with which the message was added. If 0, -/// then TDLib will crash as soon as the callback returns.</param> +/// <param name="verbosityLevel">Log verbosity level with which the message was added (-1 - 1024). +/// If 0, then TDLib will crash as soon as the callback returns. +/// None of the TDLib methods can be called from the callback.</param> /// <param name="message">Null-terminated string with the message added to the log.</param> public delegate void LogMessageCallback(int verbosityLevel, String^ message); #endif diff --git a/td/telegram/td_json_client.h b/td/telegram/td_json_client.h index f2b8e09e2..57dd0ed4a 100644 --- a/td/telegram/td_json_client.h +++ b/td/telegram/td_json_client.h @@ -159,7 +159,9 @@ TDJSON_EXPORT const char *td_execute(const char *request); /** * A type of callback function that will be called when a message is added to the internal TDLib log. * - * \param verbosity_level Log verbosity level with which the message was added. + * \param verbosity_level Log verbosity level with which the message was added (-1 - 1024). + * If 0, then TDLib will crash as soon as the callback returns. + * None of the TDLib methods can be called from the callback. * \param message Null-terminated string with the logged message. */ typedef void (*td_log_message_callback_ptr)(int verbosity_level, const char *message); @@ -167,7 +169,6 @@ typedef void (*td_log_message_callback_ptr)(int verbosity_level, const char *mes /** * Sets the callback that will be called when a message is added to the internal TDLib log. * None of the TDLib methods can be called from the callback. - * If message verbosity level is 0, then TDLib will crash as soon as callback returns. * By default the callback is not set. * * \param[in] max_verbosity_level Maximum verbosity level of messages for which the callback will be called. |
