diff --git a/README.md b/README.md index f2f95cd..8a31d84 100644 --- a/README.md +++ b/README.md @@ -151,3 +151,4 @@ Mantainers: - [grammers](https://github.com/Lonami/grammers): the `tdlib-tl-gen` and `tdlib-tl-parser` projects are forks of the `grammers-tl-gen` and `grammers-tl-parser` projects. - [rust-tdlib](https://github.com/aCLr/rust-tdlib): for inspiration about some client code. - [tdlib-rs](https://github.com/paper-plane-developers/tdlib-rs): for inspiration about the generator code. + diff --git a/tdlib-rs/src/build.rs b/tdlib-rs/src/build.rs index f7ea64c..ae06f19 100644 --- a/tdlib-rs/src/build.rs +++ b/tdlib-rs/src/build.rs @@ -6,7 +6,6 @@ #[allow(dead_code)] #[cfg(not(any(feature = "docs", feature = "pkg-config")))] -// The version of the TDLib library. const TDLIB_VERSION: &str = "1.8.29"; #[cfg(feature = "download-tdlib")] const TDLIB_CARGO_PKG_VERSION: &str = "1.0.5"; @@ -136,8 +135,11 @@ fn download_tdlib() { /// - `cargo:rustc-link-lib=dylib=tdjson` /// - `cargo:rustc-link-arg=-Wl,-rpath,.../tdlib/lib` /// - `cargo:rustc-link-search=native=.../tdlib/bin` (only for Windows x86_64) +/// /// The `...` represents the `dest_path` or the `OUT_DIR` environment variable. +/// /// If the tdlib library is not found at the specified path, the function will panic. +/// /// The function will panic if the tdlib library is not found at the specified path. fn generic_build(lib_path: Option) { let correct_lib_path: String; @@ -391,7 +393,9 @@ pub fn build_download_tdlib(dest_path: Option) { /// - `cargo:rustc-link-lib=dylib=tdjson` /// - `cargo:rustc-link-arg=-Wl,-rpath,.../tdlib/lib` /// - `cargo:rustc-link-search=native=.../tdlib/bin` (only for Windows x86_64) +/// /// The `...` represents the `LOCAL_TDLIB_PATH` environment variable. +/// /// If the `LOCAL_TDLIB_PATH` environment variable is not set, the function will panic. /// /// # Example