Skip to content

Commit 0f85b71

Browse files
committed
Add documentation for ClickOptions
1 parent b2eb2ee commit 0f85b71

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

chromiumoxide_types/src/lib.rs

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -267,46 +267,66 @@ impl From<String> for Binary {
267267
}
268268
}
269269

270+
/// Options that control how a click action is performed.
270271
#[derive(Clone, Debug)]
271272
pub struct ClickOptions {
273+
/// Number of times the click action should be executed.
274+
///
275+
/// A value of `1` represents a single click.
272276
pub click_count: i64,
273277
}
274278

275279
impl Default for ClickOptions {
280+
/// Creates a [`ClickOptions`] instance with default values.
281+
///
282+
/// Default values:
283+
/// - `click_count`: `1`
276284
fn default() -> Self {
277285
Self { click_count: 1 }
278286
}
279287
}
280288

281289
impl ClickOptions {
290+
/// Creates a new [`ClickOptions`] using default values.
282291
pub fn new() -> Self {
283292
Self::default()
284293
}
294+
295+
/// Creates a builder for constructing [`ClickOptions`].
285296
pub fn builder() -> ClickOptionsBuilder {
286297
ClickOptionsBuilder::default()
287298
}
288299
}
289300

301+
/// Builder for [`ClickOptions`].
290302
#[derive(Clone, Debug)]
291303
pub struct ClickOptionsBuilder {
292304
click_count: i64,
293305
}
294306

295307
impl Default for ClickOptionsBuilder {
308+
/// Creates a [`ClickOptionsBuilder`] with default values.
309+
///
310+
/// Default values:
311+
/// - `click_count`: `1`
296312
fn default() -> Self {
297313
Self { click_count: 1 }
298314
}
299315
}
300316

301317
impl ClickOptionsBuilder {
318+
/// Creates a new [`ClickOptionsBuilder`].
302319
pub fn new() -> Self {
303320
Self::default()
304321
}
322+
323+
/// Sets how many times the click action should be executed.
305324
pub fn click_count(mut self, count: impl Into<i64>) -> Self {
306325
self.click_count = count.into();
307326
self
308327
}
309328

329+
/// Builds the [`ClickOptions`] instance.
310330
pub fn build(self) -> ClickOptions {
311331
ClickOptions {
312332
click_count: self.click_count,

0 commit comments

Comments
 (0)