cxx-qt-gen: enable missing_docs and fix missing docs

Author: ahayzen-kdab

crates/cxx-qt-gen/src/generator/cpp/fragment.rs

@@ -4,9 +4,18 @@
 // SPDX-License-Identifier: MIT OR Apache-2.0
 
 #[derive(PartialEq, Eq, Debug)]
+/// A fragment of C++ code
 pub enum CppFragment {
-    Pair { header: String, source: String },
+    /// A fragment which only both a header and a source
+    Pair {
+        /// The header of the fragment
+        header: String,
+        /// The source of the fragment
+        source: String,
+    },
+    /// A fragment which only has a header
     Header(String),
+    /// A fragment which only has a source
     Source(String),
 }
 

crates/cxx-qt-gen/src/generator/cpp/mod.rs

@@ -39,6 +39,7 @@ pub struct GeneratedCppBlocks {
 }
 
 impl GeneratedCppBlocks {
+    /// Create a [GeneratedCppBlocks] from the given [Parser] object
     pub fn from(parser: &Parser) -> Result<GeneratedCppBlocks> {
         let mut includes = BTreeSet::new();
 

crates/cxx-qt-gen/src/generator/rust/mod.rs

@@ -33,6 +33,7 @@ pub struct GeneratedRustBlocks {
 }
 
 impl GeneratedRustBlocks {
+    /// Create a [GeneratedRustBlocks] from the given [Parser] object
     pub fn from(parser: &Parser) -> Result<GeneratedRustBlocks> {
         let mut fragments = vec![];
         fragments.extend(

crates/cxx-qt-gen/src/lib.rs

@@ -3,6 +3,11 @@
 // SPDX-FileContributor: Gerhard de Clercq <[email protected]>
 //
 // SPDX-License-Identifier: MIT OR Apache-2.0
+
+#![deny(missing_docs)]
+
+//! The cxx-qt-gen crate provides methods for generated C++ and Rust code from a TokenStream.
+
 mod generator;
 mod naming;
 mod parser;
@@ -13,8 +18,8 @@ pub use generator::{
     cpp::{fragment::CppFragment, GeneratedCppBlocks},
     rust::GeneratedRustBlocks,
 };
-pub use parser::{qobject::QmlElementMetadata, Parser};
-pub use syntax::{parse_qt_file, CxxQtItem};
+pub use parser::Parser;
+pub use syntax::{parse_qt_file, CxxQtFile, CxxQtItem};
 pub use writer::{cpp::write_cpp, rust::write_rust};
 
 pub use syn::{Error, Result};

crates/cxx-qt-gen/src/parser/mod.rs

@@ -30,11 +30,11 @@ use syn::{
 /// [syn::Item]'s that are not handled specially by CXX-Qt are passed through for CXX to process.
 pub struct Parser {
     /// The module which unknown (eg CXX) blocks are stored into
-    pub passthrough_module: ItemMod,
+    pub(crate) passthrough_module: ItemMod,
     /// Any CXX-Qt data that needs generation later
-    pub cxx_qt_data: ParsedCxxQtData,
+    pub(crate) cxx_qt_data: ParsedCxxQtData,
     /// all type names that were found in this module, including CXX types
-    pub type_names: TypeNames,
+    pub(crate) type_names: TypeNames,
     /// The stem of the file that the CXX headers for this module will be generated into
     pub cxx_file_stem: String,
 }

crates/cxx-qt-gen/src/syntax/mod.rs

@@ -13,5 +13,5 @@ mod qtitem;
 pub mod safety;
 pub mod types;
 
-pub use qtfile::parse_qt_file;
+pub use qtfile::{parse_qt_file, CxxQtFile};
 pub use qtitem::CxxQtItem;

crates/cxx-qt-gen/src/syntax/qtfile.rs

@@ -9,8 +9,11 @@ use quote::{ToTokens, TokenStreamExt};
 use syn::parse::{Parse, ParseStream};
 use syn::{AttrStyle, Attribute, Result};
 
+/// Representation of a CxxQtFile as Syn items
 pub struct CxxQtFile {
+    /// A vector of [syn::Attribute] in the file
     pub attrs: Vec<Attribute>,
+    /// A vector of [CxxQtItem] items in the file
     pub items: Vec<CxxQtItem>,
 }
 
@@ -40,6 +43,7 @@ impl ToTokens for CxxQtFile {
     }
 }
 
+/// Parse the given [std::path::Path] into a [CxxQtFile]
 pub fn parse_qt_file(path: impl AsRef<std::path::Path>) -> Result<CxxQtFile> {
     let source = std::fs::read_to_string(path.as_ref()).unwrap_or_else(|err| {
         // todo: fixme with a proper error propagation

crates/cxx-qt-gen/src/syntax/qtitem.rs

@@ -10,8 +10,7 @@ use syn::parse::{Parse, ParseStream};
 use syn::{Attribute, Item, ItemMod, Result, Token, Visibility};
 
 #[derive(Clone, PartialEq, Eq)]
-// This warning is triggered when running clippy on crates that depend on cxx-qt-gen,
-// but not when running clippy on cxx-qt-gen.
+/// Representation of either a Syn Item, a CXX module, or a CXX-Qt module
 pub enum CxxQtItem {
     /// A normal syntax item that we pass through
     Item(Item),