Skip to content
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions crates/cargo-wdk/src/main.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
// Copyright (c) Microsoft Corporation
// License: MIT OR Apache-2.0
//! [`cargo-wdk`] is a Cargo extension that can be used to create build and
//! package Windows driver projects.
//! The [`cargo-wdk`][crate] crate is a Cargo extension that can be used to
//! create build and package Windows driver projects.

#![allow(clippy::multiple_crate_versions)]
/// The `regex-syntax` and `regex-automata` crates have multiple version
Expand All @@ -16,7 +16,7 @@ use clap::Parser;
use cli::Cli;
use tracing::error;

/// Main function for the cargo-wdk CLI application.
/// Main function for the [`cargo-wdk`][crate] CLI application.
///
/// The main function parses the CLI input, sets up tracing and executes the
/// command. If an error occurs during execution, it logs the error and exits
Expand Down
8 changes: 4 additions & 4 deletions crates/wdk-build/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
// Copyright (c) Microsoft Corporation
// License: MIT OR Apache-2.0

//! [`wdk-build`] is a library that is used within Cargo build scripts to
//! configure any build that depends on the WDK (Windows Driver Kit). This is
//! especially useful for crates that generate FFI bindings to the WDK,
//! The [`wdk-build`][crate] crate is a library that is used within Cargo build
//! scripts to configure any build that depends on the WDK (Windows Driver Kit).
//! This is especially useful for crates that generate FFI bindings to the WDK,
//! WDK-dependent libraries, and programs built on top of the WDK (ex. Drivers).
//! This library is built to be able to accommodate different WDK releases, as
//! well strives to allow for all the configuration the WDK allows. This
Expand Down Expand Up @@ -139,7 +139,7 @@ pub struct UmdfConfig {
pub minimum_umdf_version_minor: Option<u8>,
}

/// Errors that could result from configuring a build via [`wdk-build`]
/// Errors that could result from configuring a build via [`wdk_build`][crate]
#[derive(Debug, Error)]
pub enum ConfigError {
/// Error returned when an [`std::io`] operation fails
Expand Down
12 changes: 7 additions & 5 deletions crates/wdk-macros/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@
// License: MIT OR Apache-2.0

//! A collection of macros that help make it easier to interact with
//! [`wdk-sys`]'s direct bindings to the Windows Driver Kit (WDK).
//! [`wdk_sys`](../wdk_sys/index.html)'s direct bindings to the Windows Driver
//! Kit (WDK).

use std::{collections::BTreeMap, path::PathBuf, str::FromStr};

Expand Down Expand Up @@ -49,10 +50,11 @@ const WDF_FUNC_ENUM_MOD_NAME: &str = "_WDFFUNCENUM";

/// A procedural macro that allows WDF functions to be called by name.
///
/// This macro is only intended to be used in the `wdk-sys` crate. Users wanting
/// to call WDF functions should use the macro in `wdk-sys`. This macro differs
/// from the one in [`wdk-sys`] in that it must pass in the generated types from
/// `wdk-sys` as an argument to the macro.
/// This macro is only intended to be used in the
/// [`wdk_sys`](../wdk_sys/index.html) crate. Users wanting to call WDF
/// functions should use the macro in [`wdk_sys`](../wdk_sys/index.html). This
/// macro differs from the one in [`wdk_sys`](../wdk_sys/index.html) in that it
/// must pass in the generated types from `wdk-sys` as an argument to the macro.
#[proc_macro]
pub fn call_unsafe_wdf_function_binding(input_tokens: TokenStream) -> TokenStream {
call_unsafe_wdf_function_binding_impl(TokenStream2::from(input_tokens)).into()
Expand Down
2 changes: 1 addition & 1 deletion crates/wdk/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
// License: MIT OR Apache-2.0

//! Idiomatic Rust wrappers for the Windows Driver Kit (WDK) APIs. This crate is
//! built on top of the raw FFI bindings provided by [`wdk-sys`], and provides a
//! built on top of the raw FFI bindings provided by [`wdk_sys`], and provides a
//! safe, idiomatic rust interface to the WDK.

#![cfg_attr(
Expand Down
Loading