Skip to content

Commit

Permalink
doc: Use intra doc links instead of HTML tags
Browse files Browse the repository at this point in the history
  • Loading branch information
caspermeijn committed Jan 3, 2025
1 parent 68cf18a commit 15d0a74
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions prost-build/src/config.rs
Original file line number Diff line number Diff line change
Expand Up @@ -187,11 +187,11 @@ impl Config {
/// # Arguments
///
/// **`path`** - a path matching any number of fields. These fields get the attribute.
/// For details about matching fields see [`btree_map`](#method.btree_map).
/// For details about matching fields see [`btree_map`](Self::btree_map).
///
/// **`attribute`** - an arbitrary string that'll be placed before each matched field. The
/// expected usage are additional attributes, usually in concert with whole-type
/// attributes set with [`type_attribute`](method.type_attribute), but it is not
/// attributes set with [`type_attribute`](Self::type_attribute), but it is not
/// checked and anything can be put there.
///
/// Note that the calls to this method are cumulative ‒ if multiple paths from multiple calls
Expand Down Expand Up @@ -220,7 +220,7 @@ impl Config {
/// # Arguments
///
/// **`paths`** - a path matching any number of types. It works the same way as in
/// [`btree_map`](#method.btree_map), just with the field name omitted.
/// [`btree_map`](Self::btree_map), just with the field name omitted.
///
/// **`attribute`** - an arbitrary string to be placed before each matched type. The
/// expected usage are additional attributes, but anything is allowed.
Expand All @@ -230,7 +230,7 @@ impl Config {
/// it.
///
/// For things like serde it might be needed to combine with [field
/// attributes](#method.field_attribute).
/// attributes](Self::field_attribute).
///
/// # Examples
///
Expand Down Expand Up @@ -269,7 +269,7 @@ impl Config {
/// # Arguments
///
/// **`paths`** - a path matching any number of types. It works the same way as in
/// [`btree_map`](#method.btree_map), just with the field name omitted.
/// [`btree_map`](Self::btree_map), just with the field name omitted.
///
/// **`attribute`** - an arbitrary string to be placed before each matched type. The
/// expected usage are additional attributes, but anything is allowed.
Expand All @@ -279,7 +279,7 @@ impl Config {
/// it.
///
/// For things like serde it might be needed to combine with [field
/// attributes](#method.field_attribute).
/// attributes](Self::field_attribute).
///
/// # Examples
///
Expand Down Expand Up @@ -308,7 +308,7 @@ impl Config {
/// # Arguments
///
/// **`paths`** - a path matching any number of types. It works the same way as in
/// [`btree_map`](#method.btree_map), just with the field name omitted.
/// [`btree_map`](Self::btree_map), just with the field name omitted.
///
/// **`attribute`** - an arbitrary string to be placed before each matched type. The
/// expected usage are additional attributes, but anything is allowed.
Expand All @@ -318,7 +318,7 @@ impl Config {
/// it.
///
/// For things like serde it might be needed to combine with [field
/// attributes](#method.field_attribute).
/// attributes](Self::field_attribute).
///
/// # Examples
///
Expand Down Expand Up @@ -357,7 +357,7 @@ impl Config {
/// # Arguments
///
/// **`path`** - a path matching any number of fields. These fields get the attribute.
/// For details about matching fields see [`btree_map`](#method.btree_map).
/// For details about matching fields see [`btree_map`](Self::btree_map).
///
/// # Examples
///
Expand Down Expand Up @@ -666,7 +666,7 @@ impl Config {
/// # Domains
///
/// **`paths`** - a path matching any number of types. It works the same way as in
/// [`btree_map`](#method.btree_map), just with the field name omitted.
/// [`btree_map`](Self::btree_map), just with the field name omitted.
///
/// **`domain`** - an arbitrary string to be used as a prefix for type URLs.
///
Expand Down
4 changes: 2 additions & 2 deletions prost-build/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ pub trait ServiceGenerator {
/// Finalizes the generation process.
///
/// In case there's something that needs to be output at the end of the generation process, it
/// goes here. Similar to [`generate`](#method.generate), the output should be appended to
/// goes here. Similar to [`generate`](Self::generate), the output should be appended to
/// `buf`.
///
/// An example can be a module or other thing that needs to appear just once, not for each
Expand All @@ -196,7 +196,7 @@ pub trait ServiceGenerator {

/// Finalizes the generation process for an entire protobuf package.
///
/// This differs from [`finalize`](#method.finalize) by where (and how often) it is called
/// This differs from [`finalize`](Self::finalize) by where (and how often) it is called
/// during the service generator life cycle. This method is called once per protobuf package,
/// making it ideal for grouping services within a single package spread across multiple
/// `.proto` files.
Expand Down

0 comments on commit 15d0a74

Please sign in to comment.