Skip to content

Commit

Permalink
Fix clippy::doc_lazy_continuation lints
Browse files Browse the repository at this point in the history
  • Loading branch information
waywardmonkeys authored and pvdrz committed Jul 2, 2024
1 parent 218bae9 commit 7600bf8
Show file tree
Hide file tree
Showing 6 changed files with 23 additions and 23 deletions.
6 changes: 3 additions & 3 deletions bindgen/codegen/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -1658,13 +1658,13 @@ fn access_specifier(

/// Compute a fields or structs visibility based on multiple conditions.
/// 1. If the element was declared public, and we respect such CXX accesses specs
/// (context option) => By default Public, but this can be overruled by an `annotation`.
/// (context option) => By default Public, but this can be overruled by an `annotation`.
///
/// 2. If the element was declared private, and we respect such CXX accesses specs
/// (context option) => By default Private, but this can be overruled by an `annotation`.
/// (context option) => By default Private, but this can be overruled by an `annotation`.
///
/// 3. If we do not respect visibility modifiers, the result depends on the `annotation`,
/// if any, or the passed `default_kind`.
/// if any, or the passed `default_kind`.
///
fn compute_visibility(
ctx: &BindgenContext,
Expand Down
6 changes: 3 additions & 3 deletions bindgen/ir/analysis/sizedness.rs
Original file line number Diff line number Diff line change
Expand Up @@ -87,13 +87,13 @@ impl ops::BitOrAssign for SizednessResult {
/// An analysis that computes the sizedness of all types.
///
/// * For types with known sizes -- for example pointers, scalars, etc... --
/// they are assigned `NonZeroSized`.
/// they are assigned `NonZeroSized`.
///
/// * For compound structure types with one or more fields, they are assigned
/// `NonZeroSized`.
/// `NonZeroSized`.
///
/// * For compound structure types without any fields, the results of the bases
/// are `join`ed.
/// are `join`ed.
///
/// * For type parameters, `DependsOnTypeParam` is assigned.
#[derive(Debug)]
Expand Down
4 changes: 2 additions & 2 deletions bindgen/ir/analysis/template_params.rs
Original file line number Diff line number Diff line change
Expand Up @@ -124,8 +124,8 @@ use crate::{HashMap, HashSet};
/// ```
///
/// * Finally, for all other IR item kinds, we use our lattice's `join`
/// operation: set union with each successor of the given item's template
/// parameter usage:
/// operation: set union with each successor of the given item's template
/// parameter usage:
///
/// ```ignore
/// template_param_usage(v) =
Expand Down
4 changes: 2 additions & 2 deletions bindgen/ir/derive.rs
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,10 @@
//! These traits tend to come in pairs:
//!
//! 1. A "trivial" version, whose implementations aren't allowed to recursively
//! look at other types or the results of fix point analyses.
//! look at other types or the results of fix point analyses.
//!
//! 2. A "normal" version, whose implementations simply query the results of a
//! fix point analysis.
//! fix point analysis.
//!
//! The former is used by the analyses when creating the results queried by the
//! second.
Expand Down
8 changes: 4 additions & 4 deletions bindgen/ir/template.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
//! brief definitions:
//!
//! * "Template definition": a class/struct/alias/function definition that takes
//! generic template parameters. For example:
//! generic template parameters. For example:
//!
//! ```c++
//! template<typename T>
Expand All @@ -14,11 +14,11 @@
//! ```
//!
//! * "Template instantiation": an instantiation is a use of a template with
//! concrete template arguments. For example, `List<int>`.
//! concrete template arguments. For example, `List<int>`.
//!
//! * "Template specialization": an alternative template definition providing a
//! custom definition for instantiations with the matching template
//! arguments. This C++ feature is unsupported by bindgen. For example:
//! custom definition for instantiations with the matching template
//! arguments. This C++ feature is unsupported by bindgen. For example:
//!
//! ```c++
//! template<>
Expand Down
18 changes: 9 additions & 9 deletions bindgen/options/mod.rs
Original file line number Diff line number Diff line change
Expand Up @@ -35,20 +35,20 @@ use helpers::ignore;
/// a block of code with the following items:
///
/// - `default`: The default value for the field. If this item is omitted, `Default::default()` is
/// used instead, meaning that the type of the field must implement `Default`.
/// used instead, meaning that the type of the field must implement `Default`.
/// - `methods`: A block of code containing methods for the `Builder` type. These methods should be
/// related to the field being declared.
/// related to the field being declared.
/// - `as_args`: This item declares how the field should be converted into a valid CLI argument for
/// `bindgen` and is used in the [`Builder::command_line_flags`] method which is used to do a
/// roundtrip test of the CLI args in the `bindgen-test` crate. This item can take one of the
/// following:
/// `bindgen` and is used in the [`Builder::command_line_flags`] method which is used to do a
/// roundtrip test of the CLI args in the `bindgen-test` crate. This item can take one of the
/// following:
/// - A string literal with the flag if the type of the field implements the [`AsArgs`] trait.
/// - A closure with the signature `|field, args: &mut Vec<String>| -> ()` that pushes arguments
/// into the `args` buffer based on the value of the field. This is used if the field does not
/// implement `AsArgs` or if the implementation of the trait is not logically correct for the
/// option and a custom behavior must be taken into account.
/// into the `args` buffer based on the value of the field. This is used if the field does not
/// implement `AsArgs` or if the implementation of the trait is not logically correct for the
/// option and a custom behavior must be taken into account.
/// - The `ignore` literal, which does not emit any CLI arguments for this field. This is useful
/// if the field cannot be used from the `bindgen` CLI.
/// if the field cannot be used from the `bindgen` CLI.
///
/// As an example, this would be the declaration of a `bool` field called `be_fun` whose default
/// value is `false` (the `Default` value for `bool`):
Expand Down

0 comments on commit 7600bf8

Please sign in to comment.