Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add root level documentation for all libraries #3202

Merged
merged 6 commits into from
Aug 15, 2024
Merged
Changes from 1 commit
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
Prev Previous commit
Next Next commit
fix: fmt
Nerixyz committed Aug 14, 2024

Verified

This commit was signed with the committer’s verified signature.
Nerixyz nerix
commit 100a7ed86487a73d335d40754c5f41da902c8e86
1 change: 0 additions & 1 deletion crates/libs/core/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![doc(html_no_source)]
#![allow(non_snake_case)]
#![cfg_attr(
1 change: 0 additions & 1 deletion crates/libs/cppwinrt/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![cfg(windows)]

const VERSION: &str = "2.0.240405.15";
4 changes: 2 additions & 2 deletions crates/libs/implement/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Implement COM interfaces for Rust types.
//!
//!
//! Take a look at [macro@implement] for an example.
//!
//!
//! Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>

use quote::{quote, ToTokens};
4 changes: 2 additions & 2 deletions crates/libs/interface/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//! Define COM interfaces to call or implement.
//!
//!
//! Take a look at [macro@interface] for an example.
//!
//!
//! Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>

use quote::quote;
1 change: 0 additions & 1 deletion crates/libs/metadata/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![doc(hidden)]

use std::cmp::Ordering;
1 change: 0 additions & 1 deletion crates/libs/registry/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![cfg(windows)]
#![no_std]

1 change: 0 additions & 1 deletion crates/libs/result/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![cfg_attr(
windows_debugger_visualizer,
debugger_visualizer(natvis_file = "../.natvis")
1 change: 0 additions & 1 deletion crates/libs/strings/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![cfg(windows)]
#![allow(non_snake_case)]
#![cfg_attr(
11 changes: 1 addition & 10 deletions crates/libs/sys/src/lib.rs
Original file line number Diff line number Diff line change
@@ -6,17 +6,8 @@
),
doc = include_str!("../README.md")
)]

// fallback if not all features are enabled
#![cfg_attr(
not(all(
feature = "Win32_Security",
feature = "Win32_System_Threading",
feature = "Win32_UI_WindowsAndMessaging",
)),
doc = "Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>\n\n[Feature search](https://microsoft.github.io/windows-rs/features/#/0.58.0)",
)]

#![cfg_attr(not(all(feature = "Win32_Security", feature = "Win32_System_Threading", feature = "Win32_UI_WindowsAndMessaging",)), doc = "Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>\n\n[Feature search](https://microsoft.github.io/windows-rs/features/#/0.58.0)")]
#![no_std]
#![doc(html_no_source)]
#![allow(non_snake_case, non_upper_case_globals, non_camel_case_types, missing_docs, clippy::all)]
1 change: 0 additions & 1 deletion crates/libs/targets/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![no_std]

/// Defines an external function to import.
1 change: 0 additions & 1 deletion crates/libs/version/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
#![doc = include_str!("../README.md")]

#![cfg(windows)]
#![cfg_attr(not(test), no_std)]

16 changes: 1 addition & 15 deletions crates/libs/windows/src/lib.rs
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
#![cfg_attr(docsrs, doc = "This is a stub. The latest API documentation is here: <https://microsoft.github.io/windows-docs-rs/>")]
#![cfg_attr(docsrs, doc = "")]

#![cfg_attr(
all(
feature = "Data_Xml_Dom",
@@ -10,21 +9,8 @@
),
doc = include_str!("../README.md"),
)]

// fallback if not all features are enabled
#![cfg_attr(
all(
not(all(
feature = "Data_Xml_Dom",
feature = "Win32_Security",
feature = "Win32_System_Threading",
feature = "Win32_UI_WindowsAndMessaging",
)),
not(docsrs),
),
doc = "Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>\n\n[Feature search](https://microsoft.github.io/windows-rs/features/#/0.58.0)",
)]

#![cfg_attr(all(not(all(feature = "Data_Xml_Dom", feature = "Win32_Security", feature = "Win32_System_Threading", feature = "Win32_UI_WindowsAndMessaging",)), not(docsrs),), doc = "Learn more about Rust for Windows here: <https://github.com/microsoft/windows-rs>\n\n[Feature search](https://microsoft.github.io/windows-rs/features/#/0.58.0)")]
#![cfg(windows)]
#![doc(html_no_source)]
#![allow(non_snake_case, clashing_extern_declarations, non_upper_case_globals, non_camel_case_types, missing_docs, clippy::all)]