Skip to content

Commit 3427e41

Browse files
committed
qt-build-utils: enable missing_docs and fix missing docs
1 parent 10677ce commit 3427e41

File tree

1 file changed

+9
-0
lines changed
  • crates/qt-build-utils/src

1 file changed

+9
-0
lines changed

crates/qt-build-utils/src/lib.rs

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
//
44
// SPDX-License-Identifier: MIT OR Apache-2.0
55

6+
#![deny(missing_docs)]
7+
68
//! This crate provides information about the Qt installation and can invoke Qt's
79
//! [moc](https://doc.qt.io/qt-6/moc.html) code generator. This crate does not build
810
//! any C++ code on its own. It is intended to be used in [build.rs scripts](https://doc.rust-lang.org/cargo/reference/build-scripts.html)
@@ -28,11 +30,14 @@ pub use versions::SemVer;
2830
use thiserror::Error;
2931

3032
#[derive(Error, Debug)]
33+
/// Errors that can occur while using [QtBuild]
3134
pub enum QtBuildError {
3235
/// `QMAKE` environment variable was set but Qt was not detected
3336
#[error("QMAKE environment variable specified as {qmake_env_var} but could not detect Qt: {error:?}")]
3437
QMakeSetQtMissing {
38+
/// The value of the qmake environment variable when the error occurred
3539
qmake_env_var: String,
40+
/// The inner [QtBuildError] that occurred
3641
error: Box<QtBuildError>,
3742
},
3843
/// Qt was not found
@@ -44,13 +49,17 @@ pub enum QtBuildError {
4449
/// `QT_VERSION_MAJOR` environment variable was specified but could not be parsed as an integer
4550
#[error("QT_VERSION_MAJOR environment variable specified as {qt_version_major_env_var} but could not parse as integer: {source:?}")]
4651
QtVersionMajorInvalid {
52+
/// The Qt major version from `QT_VERSION_MAJOR`
4753
qt_version_major_env_var: String,
54+
/// The [std::num::ParseIntError] when parsing the `QT_VERSION_MAJOR`
4855
source: std::num::ParseIntError,
4956
},
5057
/// `QT_VERSION_MAJOR` environment variable was specified but the Qt version specified by `qmake -query QT_VERSION` did not match
5158
#[error("qmake version ({qmake_version}) does not match version specified by QT_VERSION_MAJOR ({qt_version_major})")]
5259
QtVersionMajorDoesNotMatch {
60+
/// The qmake version
5361
qmake_version: u32,
62+
/// The Qt major version from `QT_VERSION_MAJOR`
5463
qt_version_major: u32,
5564
},
5665
}

0 commit comments

Comments
 (0)