Skip to content

Commit 9a91ddd

Browse files
SpriteOvOSpriteOvO
committed
Improve builder structs doc, add default values to methods doc
1 parent bd59ff0 commit 9a91ddd

File tree

12 files changed

+95
-73
lines changed

12 files changed

+95
-73
lines changed

‎spdlog/src/logger.rs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -153,7 +153,7 @@ impl Logger {
153153
/// | [name] | `None` |
154154
/// | [sinks] | `[]` |
155155
/// | [level_filter] | `MoreSevereEqual(Info)` |
156-
/// | [flush_level_filter] | `Off` |
156+
/// | [flush_level_filter] | [`LevelFilter::Off`] |
157157
/// | [flush_period] | `None` |
158158
/// | [error_handler] | [`ErrorHandler::default()`] |
159159
///
@@ -163,7 +163,6 @@ impl Logger {
163163
/// [flush_level_filter]: LoggerBuilder::flush_level_filter
164164
/// [flush_period]: Logger::set_flush_period
165165
/// [error_handler]: LoggerBuilder::error_handler
166-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
167166
#[must_use]
168167
pub fn builder() -> LoggerBuilder {
169168
LoggerBuilder {
@@ -570,7 +569,7 @@ impl LoggerBuilder {
570569

571570
/// Sets the name of the logger.
572571
///
573-
/// This parameter is **optional**.
572+
/// This parameter is **optional**, and defaults to `None`.
574573
///
575574
/// # Requirements
576575
///
@@ -589,7 +588,7 @@ impl LoggerBuilder {
589588

590589
/// Sets the log level filter.
591590
///
592-
/// This parameter is **optional**.
591+
/// This parameter is **optional**, and defaults to `MoreSevereEqual(Info)`.
593592
pub fn level_filter(&mut self, level_filter: LevelFilter) -> &mut Self {
594593
self.level_filter = level_filter;
595594
self
@@ -612,7 +611,7 @@ impl LoggerBuilder {
612611

613612
/// Sets the flush level filter.
614613
///
615-
/// This parameter is **optional**.
614+
/// This parameter is **optional**, and defaults to [`LevelFilter::Off`].
616615
///
617616
/// See the documentation of [`Logger::set_flush_level_filter`] for the
618617
/// description of this parameter.
@@ -623,7 +622,8 @@ impl LoggerBuilder {
623622

624623
/// Sets the error handler.
625624
///
626-
/// This parameter is **optional**.
625+
/// This parameter is **optional**, and defaults to
626+
/// [`ErrorHandler::default()`].
627627
///
628628
/// See the documentation of [`Logger::set_error_handler`] for the
629629
/// description of this parameter.

‎spdlog/src/sink/android_sink.rs‎

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,8 @@ pub struct AndroidSinkBuilder {
119119
impl AndroidSinkBuilder {
120120
/// Specifies how to choose a tag for Android logs.
121121
///
122-
/// This parameter is **optional**.
122+
/// This parameter is **optional**, and defaults to
123+
/// [`AndroidLogTag::Default`].
123124
#[must_use]
124125
pub fn tag(mut self, tag: AndroidLogTag) -> Self {
125126
self.tag = tag;
@@ -131,7 +132,7 @@ impl AndroidSinkBuilder {
131132

132133
/// Specifies a log level filter.
133134
///
134-
/// This parameter is **optional**.
135+
/// This parameter is **optional**, and defaults to [`LevelFilter::All`].
135136
#[must_use]
136137
pub fn level_filter(self, level_filter: LevelFilter) -> Self {
137138
self.prop.set_level_filter(level_filter);
@@ -140,7 +141,7 @@ impl AndroidSinkBuilder {
140141

141142
/// Specifies a formatter.
142143
///
143-
/// This parameter is **optional**.
144+
/// This parameter is **optional**, and defaults to `AndroidFormatter`.
144145
#[must_use]
145146
pub fn formatter<F>(self, formatter: F) -> Self
146147
where
@@ -152,7 +153,8 @@ impl AndroidSinkBuilder {
152153

153154
/// Specifies an error handler.
154155
///
155-
/// This parameter is **optional**.
156+
/// This parameter is **optional**, and defaults to
157+
/// [`ErrorHandler::default()`].
156158
#[must_use]
157159
pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self {
158160
self.prop.set_error_handler(handler);
@@ -191,16 +193,15 @@ impl AndroidSink {
191193
///
192194
/// | Parameter | Default Value |
193195
/// |-----------------|-----------------------------|
194-
/// | [level_filter] | `All` |
196+
/// | [level_filter] | [`LevelFilter::All`] |
195197
/// | [formatter] | `AndroidFormatter` |
196198
/// | [error_handler] | [`ErrorHandler::default()`] |
197199
/// | | |
198-
/// | [tag] | `AndroidSink::Default` |
200+
/// | [tag] | [`AndroidLogTag::Default`] |
199201
///
200202
/// [level_filter]: AndroidSinkBuilder::level_filter
201203
/// [formatter]: AndroidSinkBuilder::formatter
202204
/// [error_handler]: AndroidSinkBuilder::error_handler
203-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
204205
/// [tag]: AndroidSinkBuilder::tag
205206
#[must_use]
206207
pub fn builder() -> AndroidSinkBuilder {

‎spdlog/src/sink/async_sink/async_pool_sink.rs‎

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,14 +56,13 @@ impl AsyncPoolSink {
5656
///
5757
/// | Parameter | Default Value |
5858
/// |-------------------|-------------------------------------|
59-
/// | [level_filter] | `All` |
59+
/// | [level_filter] | [`LevelFilter::All`] |
6060
/// | [error_handler] | [`ErrorHandler::default()`] |
61-
/// | [overflow_policy] | `Block` |
61+
/// | [overflow_policy] | [`OverflowPolicy::Block`] |
6262
/// | [thread_pool] | internal shared default thread pool |
6363
///
6464
/// [level_filter]: AsyncPoolSinkBuilder::level_filter
6565
/// [error_handler]: AsyncPoolSinkBuilder::error_handler
66-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
6766
/// [overflow_policy]: AsyncPoolSinkBuilder::overflow_policy
6867
/// [thread_pool]: AsyncPoolSinkBuilder::thread_pool
6968
#[must_use]
@@ -175,7 +174,8 @@ impl AsyncPoolSinkBuilder {
175174

176175
/// Specifies a overflow policy.
177176
///
178-
/// This parameter is **optional**.
177+
/// This parameter is **optional**, and defaults to
178+
/// [`OverflowPolicy::Block`].
179179
///
180180
/// When the channel is full, an incoming operation is handled according to
181181
/// the specified policy.
@@ -187,7 +187,8 @@ impl AsyncPoolSinkBuilder {
187187

188188
/// Specifies a custom thread pool.
189189
///
190-
/// This parameter is **optional**.
190+
/// This parameter is **optional**, and defaults to the internal shared
191+
/// default thread pool.
191192
#[must_use]
192193
pub fn thread_pool(mut self, thread_pool: Arc<ThreadPool>) -> Self {
193194
self.thread_pool = Some(thread_pool);
@@ -199,7 +200,7 @@ impl AsyncPoolSinkBuilder {
199200

200201
/// Specifies a log level filter.
201202
///
202-
/// This parameter is **optional**.
203+
/// This parameter is **optional**, and defaults to [`LevelFilter::All`].
203204
#[must_use]
204205
pub fn level_filter(self, level_filter: LevelFilter) -> Self {
205206
self.prop.set_level_filter(level_filter);
@@ -222,7 +223,8 @@ impl AsyncPoolSinkBuilder {
222223

223224
/// Specifies an error handler.
224225
///
225-
/// This parameter is **optional**.
226+
/// This parameter is **optional**, and defaults to
227+
/// [`ErrorHandler::default()`].
226228
#[must_use]
227229
pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self {
228230
self.prop.set_error_handler(handler);

‎spdlog/src/sink/dedup_sink.rs‎

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -86,17 +86,17 @@ impl DedupSink {
8686
///
8787
/// | Parameter | Default Value |
8888
/// |-----------------|-----------------------------|
89-
/// | [level_filter] | `All` |
90-
/// | [formatter] | `FullFormatter` |
89+
/// | [level_filter] | [`LevelFilter::All`] |
90+
/// | [formatter] | [`FullFormatter`] |
9191
/// | [error_handler] | [`ErrorHandler::default()`] |
9292
/// | | |
9393
/// | [sinks] | `[]` |
9494
/// | [skip_duration] | *must be specified* |
9595
///
9696
/// [level_filter]: DedupSinkBuilder::level_filter
9797
/// [formatter]: DedupSinkBuilder::formatter
98+
/// [`FullFormatter`]: crate::formatter::FullFormatter
9899
/// [error_handler]: DedupSinkBuilder::error_handler
99-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
100100
/// [sinks]: DedupSinkBuilder::sink
101101
/// [skip_duration]: DedupSinkBuilder::skip_duration
102102
#[must_use]
@@ -250,7 +250,7 @@ impl<ArgS> DedupSinkBuilder<ArgS> {
250250

251251
/// Specifies a log level filter.
252252
///
253-
/// This parameter is **optional**.
253+
/// This parameter is **optional**, and defaults to [`LevelFilter::All`].
254254
#[must_use]
255255
pub fn level_filter(self, level_filter: LevelFilter) -> Self {
256256
self.prop.set_level_filter(level_filter);
@@ -259,7 +259,9 @@ impl<ArgS> DedupSinkBuilder<ArgS> {
259259

260260
/// Specifies a formatter.
261261
///
262-
/// This parameter is **optional**.
262+
/// This parameter is **optional**, and defaults to [`FullFormatter`].
263+
///
264+
/// [`FullFormatter`]: crate::formatter::FullFormatter
263265
#[must_use]
264266
pub fn formatter<F>(self, formatter: F) -> Self
265267
where
@@ -271,7 +273,8 @@ impl<ArgS> DedupSinkBuilder<ArgS> {
271273

272274
/// Specifies an error handler.
273275
///
274-
/// This parameter is **optional**.
276+
/// This parameter is **optional**, and defaults to
277+
/// [`ErrorHandler::default()`].
275278
#[must_use]
276279
pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self {
277280
self.prop.set_error_handler(handler);

‎spdlog/src/sink/file_sink.rs‎

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ impl FileSink {
3737
///
3838
/// | Parameter | Default Value |
3939
/// |-----------------|-----------------------------|
40-
/// | [level_filter] | `All` |
41-
/// | [formatter] | `FullFormatter` |
40+
/// | [level_filter] | [`LevelFilter::All`] |
41+
/// | [formatter] | [`FullFormatter`] |
4242
/// | [error_handler] | [`ErrorHandler::default()`] |
4343
/// | | |
4444
/// | [path] | *must be specified* |
@@ -47,8 +47,8 @@ impl FileSink {
4747
///
4848
/// [level_filter]: FileSinkBuilder::level_filter
4949
/// [formatter]: FileSinkBuilder::formatter
50+
/// [`FullFormatter`]: crate::formatter::FullFormatter
5051
/// [error_handler]: FileSinkBuilder::error_handler
51-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
5252
/// [path]: FileSinkBuilder::path
5353
/// [truncate]: FileSinkBuilder::truncate
5454
/// [capacity]: FileSinkBuilder::capacity
@@ -155,7 +155,7 @@ impl<ArgPath> FileSinkBuilder<ArgPath> {
155155
///
156156
/// If it is `true`, the existing contents of the file will be discarded.
157157
///
158-
/// This parameter is **optional**.
158+
/// This parameter is **optional**, and defaults to `false`.
159159
#[must_use]
160160
pub fn truncate(mut self, truncate: bool) -> Self {
161161
self.truncate = truncate;
@@ -164,7 +164,8 @@ impl<ArgPath> FileSinkBuilder<ArgPath> {
164164

165165
/// Specifies the internal buffer capacity.
166166
///
167-
/// This parameter is **optional**.
167+
/// This parameter is **optional**, and defaults to the value consistent
168+
/// with `std`.
168169
#[must_use]
169170
pub fn capacity(mut self, capacity: usize) -> Self {
170171
self.capacity = Some(capacity);
@@ -176,7 +177,7 @@ impl<ArgPath> FileSinkBuilder<ArgPath> {
176177

177178
/// Specifies a log level filter.
178179
///
179-
/// This parameter is **optional**.
180+
/// This parameter is **optional**, and defaults to [`LevelFilter::All`].
180181
#[must_use]
181182
pub fn level_filter(self, level_filter: LevelFilter) -> Self {
182183
self.prop.set_level_filter(level_filter);
@@ -185,7 +186,9 @@ impl<ArgPath> FileSinkBuilder<ArgPath> {
185186

186187
/// Specifies a formatter.
187188
///
188-
/// This parameter is **optional**.
189+
/// This parameter is **optional**, and defaults to [`FullFormatter`].
190+
///
191+
/// [`FullFormatter`]: crate::formatter::FullFormatter
189192
#[must_use]
190193
pub fn formatter<F>(self, formatter: F) -> Self
191194
where
@@ -197,7 +200,8 @@ impl<ArgPath> FileSinkBuilder<ArgPath> {
197200

198201
/// Specifies an error handler.
199202
///
200-
/// This parameter is **optional**.
203+
/// This parameter is **optional**, and defaults to
204+
/// [`ErrorHandler::default()`].
201205
#[must_use]
202206
pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self {
203207
self.prop.set_error_handler(handler);

‎spdlog/src/sink/journald_sink.rs‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -99,14 +99,13 @@ impl JournaldSink {
9999
///
100100
/// | Parameter | Default Value |
101101
/// |-----------------|-----------------------------|
102-
/// | [level_filter] | `All` |
102+
/// | [level_filter] | [`LevelFilter::All`] |
103103
/// | [formatter] | `JournaldFormatter` |
104104
/// | [error_handler] | [`ErrorHandler::default()`] |
105105
///
106106
/// [level_filter]: JournaldSinkBuilder::level_filter
107107
/// [formatter]: JournaldSinkBuilder::formatter
108108
/// [error_handler]: JournaldSinkBuilder::error_handler
109-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
110109
#[must_use]
111110
pub fn builder() -> JournaldSinkBuilder {
112111
let prop = SinkProp::default();
@@ -166,7 +165,7 @@ impl JournaldSinkBuilder {
166165

167166
/// Specifies a log level filter.
168167
///
169-
/// This parameter is **optional**.
168+
/// This parameter is **optional**, and defaults to [`LevelFilter::All`].
170169
#[must_use]
171170
pub fn level_filter(self, level_filter: LevelFilter) -> Self {
172171
self.prop.set_level_filter(level_filter);
@@ -175,7 +174,7 @@ impl JournaldSinkBuilder {
175174

176175
/// Specifies a formatter.
177176
///
178-
/// This parameter is **optional**.
177+
/// This parameter is **optional**, and defaults to `JournaldFormatter`.
179178
#[must_use]
180179
pub fn formatter<F>(self, formatter: F) -> Self
181180
where
@@ -187,7 +186,8 @@ impl JournaldSinkBuilder {
187186

188187
/// Specifies an error handler.
189188
///
190-
/// This parameter is **optional**.
189+
/// This parameter is **optional**, and defaults to
190+
/// [`ErrorHandler::default()`].
191191
#[must_use]
192192
pub fn error_handler<F: Into<ErrorHandler>>(self, handler: F) -> Self {
193193
self.prop.set_error_handler(handler);

‎spdlog/src/sink/mod.rs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -88,11 +88,9 @@ impl Default for SinkProp {
8888
///
8989
/// | Parameter | Default Value |
9090
/// |-----------------|-----------------------------|
91-
/// | `level_filter` | `All` |
92-
/// | `formatter` | `FullFormatter` |
91+
/// | `level_filter` | [`LevelFilter::All`] |
92+
/// | `formatter` | [`FullFormatter`] |
9393
/// | `error_handler` | [`ErrorHandler::default()`] |
94-
///
95-
/// [`ErrorHandler::default()`]: crate::error::ErrorHandler::default()
9694
fn default() -> Self {
9795
Self {
9896
level_filter: Atomic::new(LevelFilter::All),

0 commit comments

Comments
 (0)