Skip to content

Commit 0ec230e

Browse files
clippy: Fix doc_markdown warnings.
1 parent 78883c7 commit 0ec230e

File tree

5 files changed

+14
-13
lines changed

5 files changed

+14
-13
lines changed

src/com.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ where
6464
fn as_unknown(&self) -> &IUnknown {
6565
unsafe { &*(self.0 as *mut IUnknown) }
6666
}
67-
/// Performs QueryInterface fun.
67+
/// Performs `QueryInterface` fun.
6868
pub fn cast<U>(&self) -> Result<ComPtr<U>, i32>
6969
where
7070
U: Interface,

src/lib.rs

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -693,7 +693,7 @@ impl Build {
693693
/// `true`.
694694
///
695695
/// The name of the C++ standard library to link is decided by:
696-
/// 1. If [cpp_link_stdlib](Build::cpp_link_stdlib) is set, use its value.
696+
/// 1. If [`cpp_link_stdlib`](Build::cpp_link_stdlib) is set, use its value.
697697
/// 2. Else if the `CXXSTDLIB` environment variable is set, use its value.
698698
/// 3. Else the default is `libc++` for OS X and BSDs, `libc++_shared` for Android,
699699
/// `None` for MSVC and `libstdc++` for anything else.
@@ -708,7 +708,7 @@ impl Build {
708708
/// the most common compiler flags, e.g. `-std=c++17`, some project-specific
709709
/// flags might have to be prefixed with "-Xcompiler" flag, for example as
710710
/// `.flag("-Xcompiler").flag("-fpermissive")`. See the documentation for
711-
/// `nvcc`, the CUDA compiler driver, at https://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/
711+
/// `nvcc`, the CUDA compiler driver, at <https://docs.nvidia.com/cuda/cuda-compiler-driver-nvcc/>
712712
/// for more information.
713713
///
714714
/// If enabled, this also implicitly enables C++ support.
@@ -1044,7 +1044,7 @@ impl Build {
10441044
/// Adds a native library modifier that will be added to the
10451045
/// `rustc-link-lib=static:MODIFIERS=LIBRARY_NAME` metadata line
10461046
/// emitted for cargo if `cargo_metadata` is enabled.
1047-
/// See https://doc.rust-lang.org/rustc/command-line-arguments.html#-l-link-the-generated-crate-to-a-native-library
1047+
/// See <https://doc.rust-lang.org/rustc/command-line-arguments.html#-l-link-the-generated-crate-to-a-native-library>
10481048
/// for the list of modifiers accepted by rustc.
10491049
pub fn link_lib_modifier(&mut self, link_lib_modifier: &str) -> &mut Build {
10501050
self.link_lib_modifiers.push(link_lib_modifier.into());
@@ -1599,7 +1599,8 @@ impl Build {
15991599

16001600
/// Get the compiler that's in use for this configuration.
16011601
///
1602-
/// This will return a result instead of panicing; see get_compiler() for the complete description.
1602+
/// This will return a result instead of panicing; see
1603+
/// [`get_compiler()`](Self::get_compiler) for the complete description.
16031604
pub fn try_get_compiler(&self) -> Result<Tool, Error> {
16041605
let opt_level = self.get_opt_level()?;
16051606
let target = self.get_target()?;
@@ -2797,7 +2798,7 @@ impl Build {
27972798
}
27982799

27992800
/// Returns the C++ standard library:
2800-
/// 1. If [cpp_link_stdlib](cc::Build::cpp_link_stdlib) is set, uses its value.
2801+
/// 1. If [`cpp_link_stdlib`](cc::Build::cpp_link_stdlib) is set, uses its value.
28012802
/// 2. Else if the `CXXSTDLIB` environment variable is set, uses its value.
28022803
/// 3. Else the default is `libc++` for OS X and BSDs, `libc++_shared` for Android,
28032804
/// `None` for MSVC and `libstdc++` for anything else.
@@ -3623,7 +3624,7 @@ impl Tool {
36233624
///
36243625
/// Nvidia compiler accepts only the most common compiler flags like `-D`,
36253626
/// `-I`, `-c`, etc. Options meant specifically for the underlying
3626-
/// host C++ compiler have to be prefixed with '-Xcompiler`.
3627+
/// host C++ compiler have to be prefixed with `-Xcompiler`.
36273628
/// [Another possible future application for this function is passing
36283629
/// clang-specific flags to clang-cl, which otherwise accepts only
36293630
/// MSVC-specific options.]

src/os_pipe.rs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
//! Adapted from:
2-
//! - https://doc.rust-lang.org/src/std/sys/unix/pipe.rs.html
3-
//! - https://doc.rust-lang.org/src/std/sys/unix/fd.rs.html#385
4-
//! - https://github.com/rust-lang/rust/blob/master/library/std/src/sys/mod.rs#L57
5-
//! - https://github.com/oconnor663/os_pipe.rs
2+
//! - <https://doc.rust-lang.org/src/std/sys/unix/pipe.rs.html>
3+
//! - <https://doc.rust-lang.org/src/std/sys/unix/fd.rs.html#385>
4+
//! - <https://github.com/rust-lang/rust/blob/master/library/std/src/sys/mod.rs#L57>
5+
//! - <https://github.com/oconnor663/os_pipe.rs>
66
use std::fs::File;
77

88
/// Open a new pipe and return a pair of [`File`] objects for the reader and writer.

src/os_pipe/windows.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ use std::{fs::File, io, os::windows::prelude::*, ptr};
44
/// NOTE: These pipes do not support IOCP.
55
///
66
/// If IOCP is needed, then you might want to emulate
7-
/// anonymous pipes with CreateNamedPipe, as Rust's stdlib does.
7+
/// anonymous pipes with `CreateNamedPipe`, as Rust's stdlib does.
88
pub(super) fn pipe() -> io::Result<(File, File)> {
99
let mut read_pipe = INVALID_HANDLE_VALUE;
1010
let mut write_pipe = INVALID_HANDLE_VALUE;

src/winapi.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ use std::os::raw;
1111

1212
pub type wchar_t = u16;
1313

14-
pub use crate::windows_sys::{FILETIME, GUID, HRESULT, SAFEARRAY, SAFEARRAYBOUND};
14+
pub use crate::windows_sys::{FILETIME, GUID, HRESULT, SAFEARRAY};
1515

1616
pub type REFIID = *const IID;
1717
pub type IID = GUID;

0 commit comments

Comments
 (0)