Documentation improvements.

GitOrigin-RevId: 97c207980ea1265ebc5c4421a7bd22d77553f2f5

CMakeLists.txt

@@ -79,7 +79,7 @@ set(MEMPROF "" CACHE STRING "Use one of \"ON\", \"FAST\" or \"SAFE\" to enable m
 Works under macOS and Linux when compiled using glibc. \
 In FAST mode stack is unwinded only using frame pointers, which may fail. \
 In SAFE mode stack is unwinded using backtrace function from execinfo.h, which may be very slow. \
-By default both methods are used to achieve maximum speed and accuracy")
+By default both methods are used to achieve the maximum speed and accuracy")
 
 if (EMSCRIPTEN)
   # use prebuilt zlib

SplitSource.php

@@ -316,7 +316,10 @@ function split_file($file, $chunks, $undo) {
 }
 
 if (in_array('--help', $argv) || in_array('-h', $argv)) {
-    echo "Usage: php SplitSource.php [OPTION]...\nSplits some source files to reduce maximum RAM needed for compiling a single file.\n  -u, --undo Undo all source code changes.\n  -h, --help Show this help.\n";
+    echo "Usage: php SplitSource.php [OPTION]...\n".
+         "Splits some source files to reduce a maximum amount of RAM needed for compiling a single file.\n".
+         "  -u, --undo Undo all source code changes.\n".
+         "  -h, --help Show this help.\n";
     exit(2);
 }
 

example/java/org/drinkless/tdlib/Log.java

@@ -41,10 +41,10 @@ public final class Log {
     public static native boolean setFilePath(String filePath);
 
     /**
-     * Changes maximum size of TDLib log file.
+     * Changes the maximum size of TDLib log file.
      *
      * @deprecated As of TDLib 1.4.0 in favor of {@link TdApi.SetLogStream}, to be removed in the future.
-     * @param maxFileSize Maximum size of the file to where the internal TDLib log is written
+     * @param maxFileSize The maximum size of the file to where the internal TDLib log is written
      *                    before the file will be auto-rotated. Must be positive. Defaults to 10 MB.
      */
     @Deprecated

td/telegram/Client.h

@@ -97,7 +97,7 @@ class Client final {
   /**
    * Receives incoming updates and request responses from TDLib. May be called from any thread, but shouldn't be
    * called simultaneously from two different threads.
-   * \param[in] timeout Maximum number of seconds allowed for this function to wait for new data.
+   * \param[in] timeout The maximum number of seconds allowed for this function to wait for new data.
    * \return An incoming update or request response. The object returned in the response may be a nullptr
    *         if the timeout expires.
    */

td/telegram/Log.h

@@ -38,11 +38,11 @@ class Log {
   static bool set_file_path(std::string file_path);
 
   /**
-   * Sets maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated.
+   * Sets the maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated.
    * Unused if log is not written to a file. Defaults to 10 MB.
    *
    * \deprecated Use synchronous td::td_api::setLogStream request instead.
-   * \param[in]  max_file_size Maximum size of the file to where the internal TDLib log is written before the file
+   * \param[in]  max_file_size The maximum size of the file to where the internal TDLib log is written before the file
    *                           will be auto-rotated. Should be positive.
    */
   static void set_max_file_size(std::int64_t max_file_size);

td/telegram/LogDotNet.cpp

@@ -46,9 +46,9 @@ public:
   }
 
   /// <summary>
-  /// Changes maximum size of TDLib log file.
+  /// Changes the maximum size of TDLib log file.
   /// </summary>
-  /// <param name="maxFileSize">Maximum size of the file to where the internal TDLib log is written
+  /// <param name="maxFileSize">The maximum size of the file to where the internal TDLib log is written
   /// before the file will be auto-rotated. Must be positive. Defaults to 10 MB.</param>
   [DEPRECATED_ATTRIBUTE("SetMaxFileSize is deprecated, please use Telegram.Td.Api.SetLogStream request instead.")]
   static void SetMaxFileSize(std::int64_t maxFileSize) {

td/telegram/PollManager.cpp

@@ -361,7 +361,7 @@ vector<int32> PollManager::get_vote_percentage(const vector<int32> &voter_counts
     return result;
   }
 
-  // now we need to choose up to (100 - percent_sum) options with minimum total gap, such that
+  // now we need to choose up to (100 - percent_sum) options with a minimum total gap, such that
   // any two options with the same voter_count are chosen or not chosen simultaneously
   struct Option {
     int32 pos = -1;

td/telegram/td_json_client.h

@@ -72,7 +72,7 @@ TDJSON_EXPORT void td_json_client_send(void *client, const char *request);
  * Returned pointer will be deallocated by TDLib during next call to td_json_client_receive or td_json_client_execute
  * in the same thread, so it can't be used after that.
  * \param[in] client The client.
- * \param[in] timeout Maximum number of seconds allowed for this function to wait for new data.
+ * \param[in] timeout The maximum number of seconds allowed for this function to wait for new data.
  * \return JSON-serialized null-terminated incoming update or request response. May be NULL if the timeout expires.
  */
 TDJSON_EXPORT const char *td_json_client_receive(void *client, double timeout);

td/telegram/td_log.h

@@ -33,11 +33,11 @@ extern "C" {
 TDJSON_DEPRECATED_EXPORT int td_set_log_file_path(const char *file_path);
 
 /**
- * Sets maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated.
+ * Sets the maximum size of the file to where the internal TDLib log is written before the file will be auto-rotated.
  * Unused if log is not written to a file. Defaults to 10 MB.
  *
  * \deprecated Use synchronous setLogStream request instead.
- * \param[in]  max_file_size Maximum size of the file to where the internal TDLib log is written before the file
+ * \param[in]  max_file_size The maximum size of the file to where the internal TDLib log is written before the file
  *                           will be auto-rotated. Should be positive.
  */
 TDJSON_DEPRECATED_EXPORT void td_set_log_max_file_size(long long max_file_size);