Skip to content

Commit 5d145bb

Browse files
rosikgmoshkin
authored andcommitted
Fix doc warnings
1 parent efaaa26 commit 5d145bb

File tree

3 files changed

+19
-19
lines changed

3 files changed

+19
-19
lines changed

hlua/ffi/src/lib.rs

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1+
//! Module provides FFI bindings for the following constants,
2+
//! types and functions, realted to Lua C API:
3+
//! 1. Plain lua C API
4+
//! 2. lauxlib
5+
//! 3. Lua utitlites, implemented in Tarantool
6+
17
#![allow(non_camel_case_types)]
28
use std::os::raw::{c_double, c_int, c_schar};
39
use std::ptr::null_mut;
410

5-
/// Module provides FFI bindings for the following constants,
6-
/// types and functions, realted to Lua C API:
7-
/// 1. Plain lua C API
8-
/// 2. lauxlib
9-
/// 3. Lua utitlites, implemented in Tarantool
10-
1111
/// Lua provides a registry, a pre-defined table that can be used by any C code
1212
/// to store whatever Lua value it needs to store. This table is always located
1313
/// at pseudo-index `LUA_REGISTRYINDEX`. Any C library can store data into this
@@ -70,7 +70,7 @@ pub type lua_Integer = libc::ptrdiff_t;
7070
/// (the first argument is pushed first). So, when the function starts,
7171
/// [`lua_gettop`]`(L)` returns the number of arguments received by the function.
7272
/// The first argument (if any) is at index 1 and its last argument is at index
73-
/// [`lua_gettop`](L). To return values to Lua, a C function just pushes them
73+
/// [`lua_gettop`]`(L)`. To return values to Lua, a C function just pushes them
7474
/// onto the stack, in direct order (the first result is pushed first), and
7575
/// returns the number of results. Any other value in the stack below the
7676
/// results will be properly discarded by Lua. Like a Lua function, a C function

hlua/hlua/src/lib.rs

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -372,7 +372,7 @@ pub trait PushOne<L>: Push<L> {}
372372

373373
/// Type that cannot be instantiated.
374374
///
375-
/// Will be replaced with `!` eventually (https://github.com/rust-lang/rust/issues/35121).
375+
/// Will be replaced with `!` eventually (<https://github.com/rust-lang/rust/issues/35121>).
376376
#[derive(Debug, Copy, Clone)]
377377
pub enum Void {}
378378

@@ -523,7 +523,7 @@ impl<'lua> Lua<'lua> {
523523
/// Opens all standard Lua libraries.
524524
///
525525
/// See the reference for the standard library here:
526-
/// https://www.lua.org/manual/5.2/manual.html#6
526+
/// <https://www.lua.org/manual/5.2/manual.html#6>
527527
///
528528
/// This is done by calling `luaL_openlibs`.
529529
///
@@ -541,71 +541,71 @@ impl<'lua> Lua<'lua> {
541541

542542
/// Opens base library.
543543
///
544-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_base
544+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_base>
545545
#[inline]
546546
pub fn open_base(&mut self) {
547547
unsafe { ffi::luaopen_base(self.lua.0) }
548548
}
549549

550550
/// Opens bit32 library.
551551
///
552-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_bit32
552+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_bit32>
553553
#[inline]
554554
pub fn open_bit(&mut self) {
555555
unsafe { ffi::luaopen_bit(self.lua.0) }
556556
}
557557

558558
/// Opens debug library.
559559
///
560-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_debug
560+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_debug>
561561
#[inline]
562562
pub fn open_debug(&mut self) {
563563
unsafe { ffi::luaopen_debug(self.lua.0) }
564564
}
565565

566566
/// Opens io library.
567567
///
568-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_io
568+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_io>
569569
#[inline]
570570
pub fn open_io(&mut self) {
571571
unsafe { ffi::luaopen_io(self.lua.0) }
572572
}
573573

574574
/// Opens math library.
575575
///
576-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_math
576+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_math>
577577
#[inline]
578578
pub fn open_math(&mut self) {
579579
unsafe { ffi::luaopen_math(self.lua.0) }
580580
}
581581

582582
/// Opens os library.
583583
///
584-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_os
584+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_os>
585585
#[inline]
586586
pub fn open_os(&mut self) {
587587
unsafe { ffi::luaopen_os(self.lua.0) }
588588
}
589589

590590
/// Opens package library.
591591
///
592-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_package
592+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_package>
593593
#[inline]
594594
pub fn open_package(&mut self) {
595595
unsafe { ffi::luaopen_package(self.lua.0) }
596596
}
597597

598598
/// Opens string library.
599599
///
600-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_string
600+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_string>
601601
#[inline]
602602
pub fn open_string(&mut self) {
603603
unsafe { ffi::luaopen_string(self.lua.0) }
604604
}
605605

606606
/// Opens table library.
607607
///
608-
/// https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_table
608+
/// <https://www.lua.org/manual/5.2/manual.html#pdf-luaopen_table>
609609
#[inline]
610610
pub fn open_table(&mut self) {
611611
unsafe { ffi::luaopen_table(self.lua.0) }

tarantool/src/fiber.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -933,7 +933,7 @@ where
933933
/// **NOTE**: The argument `f` is a function that returns `T`. In case when `T =
934934
/// ()` (no return value) one should instead use [`defer_proc`].
935935
///
936-
/// The new fiber can be joined by calling [`JuaJoinHandle::join`] method on
936+
/// The new fiber can be joined by calling [`LuaJoinHandle::join`] method on
937937
/// it's join handle.
938938
pub fn defer<F, T>(f: F) -> LuaJoinHandle<T>
939939
where

0 commit comments

Comments
 (0)