Merge pull request #41 from nixops4/fix-doc

Fix `cargo doc`

nix-bindings-bdwgc-sys/src/lib.rs

@@ -1,7 +1,30 @@
+//! Raw bindings to Nix C API
+//!
+//! This crate contains automatically generated bindings from the Nix C headers.
+//! The bindings are generated by bindgen and include C-style naming conventions
+//! and documentation comments that don't always conform to Rust standards.
+//!
+//! Normally you don't have to use this crate directly.
+
+// This file must only contain generated code, so that the module-level
+// #![allow(...)] attributes don't suppress warnings in hand-written code.
+// If you need to add hand-written code, use a submodule to isolate the
+// generated code. See:
+// https://github.com/nixops4/nixops4/pull/138/commits/330c3881be3d3cf3e59adebbe0ab1c0f15f6d2c9
+
+// Standard bindgen suppressions for C naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-#![allow(dead_code)]
-#![allow(clippy::all)]
+// Clippy suppressions for generated C bindings
+// bindgen doesn't generate safety docs
+#![allow(clippy::missing_safety_doc)]
+// Rustdoc suppressions for generated C documentation
+// The C headers contain Doxygen-style documentation that doesn't translate
+// well to Rust's rustdoc format, causing various warnings:
+#![allow(rustdoc::broken_intra_doc_links)] // @param[in]/[out] references don't resolve
+#![allow(rustdoc::bare_urls)] // C docs may contain unescaped URLs
+#![allow(rustdoc::invalid_html_tags)] // Doxygen HTML tags like <setting>
+#![allow(rustdoc::invalid_codeblock_attributes)] // C code examples may use unsupported attributes
 
 include!(concat!(env!("OUT_DIR"), "/bindings.rs"));

nix-bindings-expr-sys/src/lib.rs

@@ -1,8 +1,32 @@
+//! Raw bindings to Nix C API
+//!
+//! This crate contains automatically generated bindings from the Nix C headers.
+//! The bindings are generated by bindgen and include C-style naming conventions
+//! and documentation comments that don't always conform to Rust standards.
+//!
+//! Normally you don't have to use this crate directly.
+//! Instead use `nix-expr`.
+
+// This file must only contain generated code, so that the module-level
+// #![allow(...)] attributes don't suppress warnings in hand-written code.
+// If you need to add hand-written code, use a submodule to isolate the
+// generated code. See:
+// https://github.com/nixops4/nixops4/pull/138/commits/330c3881be3d3cf3e59adebbe0ab1c0f15f6d2c9
+
+// Standard bindgen suppressions for C naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-#![allow(dead_code)]
-#![allow(clippy::all)]
+// Clippy suppressions for generated C bindings
+// bindgen doesn't generate safety docs
+#![allow(clippy::missing_safety_doc)]
+// Rustdoc suppressions for generated C documentation
+// The C headers contain Doxygen-style documentation that doesn't translate
+// well to Rust's rustdoc format, causing various warnings:
+#![allow(rustdoc::broken_intra_doc_links)] // @param[in]/[out] references don't resolve
+#![allow(rustdoc::bare_urls)] // C docs may contain unescaped URLs
+#![allow(rustdoc::invalid_html_tags)] // Doxygen HTML tags like <setting>
+#![allow(rustdoc::invalid_codeblock_attributes)] // C code examples may use unsupported attributes
 
 use nix_bindings_store_sys::*;
 use nix_bindings_util_sys::*;

nix-bindings-fetchers-sys/src/lib.rs

@@ -1,8 +1,32 @@
+//! Raw bindings to Nix C API
+//!
+//! This crate contains automatically generated bindings from the Nix C headers.
+//! The bindings are generated by bindgen and include C-style naming conventions
+//! and documentation comments that don't always conform to Rust standards.
+//!
+//! Normally you don't have to use this crate directly.
+//! Instead use `nix-fetchers`.
+
+// This file must only contain generated code, so that the module-level
+// #![allow(...)] attributes don't suppress warnings in hand-written code.
+// If you need to add hand-written code, use a submodule to isolate the
+// generated code. See:
+// https://github.com/nixops4/nixops4/pull/138/commits/330c3881be3d3cf3e59adebbe0ab1c0f15f6d2c9
+
+// Standard bindgen suppressions for C naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-#![allow(dead_code)]
-#![allow(clippy::all)]
+// Clippy suppressions for generated C bindings
+// bindgen doesn't generate safety docs
+#![allow(clippy::missing_safety_doc)]
+// Rustdoc suppressions for generated C documentation
+// The C headers contain Doxygen-style documentation that doesn't translate
+// well to Rust's rustdoc format, causing various warnings:
+#![allow(rustdoc::broken_intra_doc_links)] // @param[in]/[out] references don't resolve
+#![allow(rustdoc::bare_urls)] // C docs may contain unescaped URLs
+#![allow(rustdoc::invalid_html_tags)] // Doxygen HTML tags like <setting>
+#![allow(rustdoc::invalid_codeblock_attributes)] // C code examples may use unsupported attributes
 
 use nix_bindings_util_sys::*;
 

nix-bindings-flake-sys/src/lib.rs

@@ -1,8 +1,32 @@
+//! Raw bindings to Nix C API
+//!
+//! This crate contains automatically generated bindings from the Nix C headers.
+//! The bindings are generated by bindgen and include C-style naming conventions
+//! and documentation comments that don't always conform to Rust standards.
+//!
+//! Normally you don't have to use this crate directly.
+//! Instead use `nix-flake`.
+
+// This file must only contain generated code, so that the module-level
+// #![allow(...)] attributes don't suppress warnings in hand-written code.
+// If you need to add hand-written code, use a submodule to isolate the
+// generated code. See:
+// https://github.com/nixops4/nixops4/pull/138/commits/330c3881be3d3cf3e59adebbe0ab1c0f15f6d2c9
+
+// Standard bindgen suppressions for C naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-#![allow(dead_code)]
-#![allow(clippy::all)]
+// Clippy suppressions for generated C bindings
+// bindgen doesn't generate safety docs
+#![allow(clippy::missing_safety_doc)]
+// Rustdoc suppressions for generated C documentation
+// The C headers contain Doxygen-style documentation that doesn't translate
+// well to Rust's rustdoc format, causing various warnings:
+#![allow(rustdoc::broken_intra_doc_links)] // @param[in]/[out] references don't resolve
+#![allow(rustdoc::bare_urls)] // C docs may contain unescaped URLs
+#![allow(rustdoc::invalid_html_tags)] // Doxygen HTML tags like <setting>
+#![allow(rustdoc::invalid_codeblock_attributes)] // C code examples may use unsupported attributes
 
 use nix_bindings_expr_sys::*;
 use nix_bindings_fetchers_sys::*;

nix-bindings-store-sys/src/lib.rs

@@ -1,8 +1,32 @@
+//! Raw bindings to Nix C API
+//!
+//! This crate contains automatically generated bindings from the Nix C headers.
+//! The bindings are generated by bindgen and include C-style naming conventions
+//! and documentation comments that don't always conform to Rust standards.
+//!
+//! Normally you don't have to use this crate directly.
+//! Instead use `nix-store`.
+
+// This file must only contain generated code, so that the module-level
+// #![allow(...)] attributes don't suppress warnings in hand-written code.
+// If you need to add hand-written code, use a submodule to isolate the
+// generated code. See:
+// https://github.com/nixops4/nixops4/pull/138/commits/330c3881be3d3cf3e59adebbe0ab1c0f15f6d2c9
+
+// Standard bindgen suppressions for C naming conventions
 #![allow(non_upper_case_globals)]
 #![allow(non_camel_case_types)]
 #![allow(non_snake_case)]
-#![allow(dead_code)]
-#![allow(clippy::all)]
+// Clippy suppressions for generated C bindings
+// bindgen doesn't generate safety docs
+#![allow(clippy::missing_safety_doc)]
+// Rustdoc suppressions for generated C documentation
+// The C headers contain Doxygen-style documentation that doesn't translate
+// well to Rust's rustdoc format, causing various warnings:
+#![allow(rustdoc::broken_intra_doc_links)] // @param[in]/[out] references don't resolve
+#![allow(rustdoc::bare_urls)] // C docs may contain unescaped URLs
+#![allow(rustdoc::invalid_html_tags)] // Doxygen HTML tags like <setting>
+#![allow(rustdoc::invalid_codeblock_attributes)] // C code examples may use unsupported attributes
 
 use nix_bindings_util_sys::*;
 

nix-bindings-store/src/store.rs

@@ -102,7 +102,7 @@ pub struct Store {
 impl Store {
     /// Open a store.
     ///
-    /// See [`nix_bindings_util_sys::store_open`] for more information.
+    /// See [`nix_bindings_store_sys::store_open`] for more information.
     #[doc(alias = "nix_store_open")]
     pub fn open<'a, 'b>(
         url: Option<&str>,

nix-bindings-util-sys/src/lib.rs

@@ -5,7 +5,7 @@
 //! and documentation comments that don't always conform to Rust standards.
 //!
 //! Normally you don't have to use this crate directly.
-//! Instead use `nix-store` and `nix-expr`.
+//! Instead use `nix-util`.
 
 // This file must only contain generated code, so that the module-level
 // #![allow(...)] attributes don't suppress warnings in hand-written code.