Skip to content

Commit 91521f8

Browse files
committed
log: Reformat docs
1 parent 3da8fe7 commit 91521f8

File tree

1 file changed

+14
-7
lines changed

1 file changed

+14
-7
lines changed

qmetaobject/src/log.rs

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,16 +12,19 @@ cpp! {{
1212
}}
1313

1414
cpp_class!(
15-
/// Wrapper for Qt's QMessageLogContext
15+
/// Wrapper for [`QMessageLogContext`] class.
16+
///
17+
/// [`QMessageLogContext`]: https://doc.qt.io/qt-5/qmessagelogcontext.html
1618
pub unsafe struct QMessageLogContext as "QMessageLogContext"
1719
);
1820

1921
impl QMessageLogContext {
20-
// Return QMessageLogContext::line
22+
/// Wrapper for `QMessageLogContext::line`.
2123
pub fn line(&self) -> i32 {
2224
cpp!(unsafe [self as "QMessageLogContext*"] -> i32 as "int" { return self->line; })
2325
}
24-
// Return QMessageLogContext::file
26+
27+
/// Wrapper for `QMessageLogContext::file`.
2528
pub fn file(&self) -> &str {
2629
unsafe {
2730
let x = cpp!([self as "QMessageLogContext*"] -> *const c_char as "const char*" {
@@ -33,7 +36,8 @@ impl QMessageLogContext {
3336
std::ffi::CStr::from_ptr(x).to_str().unwrap()
3437
}
3538
}
36-
// Return QMessageLogContext::function
39+
40+
/// Wrapper for `QMessageLogContext::function`.
3741
pub fn function(&self) -> &str {
3842
unsafe {
3943
let x = cpp!([self as "QMessageLogContext*"] -> *const c_char as "const char*" {
@@ -45,7 +49,8 @@ impl QMessageLogContext {
4549
std::ffi::CStr::from_ptr(x).to_str().unwrap()
4650
}
4751
}
48-
// Return QMessageLogContext::category
52+
53+
/// Wrapper for `QMessageLogContext::category`.
4954
pub fn category(&self) -> &str {
5055
unsafe {
5156
let x = cpp!([self as "QMessageLogContext*"] -> *const c_char as "const char*" {
@@ -59,7 +64,9 @@ impl QMessageLogContext {
5964
}
6065
}
6166

62-
/// Wrap Qt's QtMsgType enum
67+
/// Wrapper for [`Qt::QtMsgType`][] enum.
68+
///
69+
/// [`Qt::QtMsgType`]: https://doc.qt.io/qt-5/qtglobal.html#QtMsgType-enum
6370
#[repr(C)]
6471
// XXX: Do NOT derive Ord and PartialOrd.
6572
// XXX: Variants are not ordered by severity.
@@ -192,7 +199,7 @@ extern "C" fn log_capture(msg_type: QtMsgType,
192199
/// This function may be called more than once.
193200
///
194201
/// [qt-log]: https://doc.qt.io/qt-5/qtglobal.html#qInstallMessageHandler
195-
/// [log]: https://docs.rs/log
202+
/// [log]: https://crates.io/crates/log
196203
/// [`log::Record`]: https://docs.rs/log/0.4.10/log/struct.Record.html
197204
/// [lvl]: ./struct.QtMsgType.html
198205
#[cfg(feature = "log")]

0 commit comments

Comments
 (0)