public inbox for gcc-cvs@sourceware.org
help / color / mirror / Atom feed
From: Arthur Cohen <cohenarthur@gcc.gnu.org>
To: gcc-cvs@gcc.gnu.org
Subject: [gcc r13-6220] gccrs: ast: refer correctly to arguments in docs-strings
Date: Tue, 21 Feb 2023 12:00:55 +0000 (GMT)	[thread overview]
Message-ID: <20230221120055.A5E9C384DD2D@sourceware.org> (raw)

https://gcc.gnu.org/g:a56faba96369cff44ec1ef0ec161c294d046951c

commit r13-6220-ga56faba96369cff44ec1ef0ec161c294d046951c
Author: Jakub Dupak <dev@jakubdupak.com>
Date:   Fri Oct 28 17:27:16 2022 +0200

    gccrs: ast: refer correctly to arguments in docs-strings
    
    gcc/rust/ChangeLog:
    
            * ast/rust-ast-dump.h: Fix documentation.
    
    Signed-off-by: Jakub Dupak <dev@jakubdupak.com>

Diff:
---
 gcc/rust/ast/rust-ast-dump.h | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/gcc/rust/ast/rust-ast-dump.h b/gcc/rust/ast/rust-ast-dump.h
index 7a8058b195e..13c92123ea9 100644
--- a/gcc/rust/ast/rust-ast-dump.h
+++ b/gcc/rust/ast/rust-ast-dump.h
@@ -81,7 +81,7 @@ private:
   template <typename T> void visit (std::unique_ptr<T> &node);
 
   /**
-   * Visit all items in given collection, placing the separator in between but
+   * Visit all items in given @collection, placing the separator in between but
    * not at the end.
    * Start and end offset allow to visit only a "slice" from the collection.
    */
@@ -99,7 +99,7 @@ private:
   void visit_as_line (T &item, const std::string &trailing = "");
 
   /**
-   * Visit each item in a collection "as line".
+   * Visit each item in @collection "as line".
    *
    * @see visit_as_line
    */
@@ -107,7 +107,7 @@ private:
   void visit_items_as_lines (T &collection, const std::string &trailing = "");
 
   /**
-   * Visit each item in collection as lines inside a block delimited by braces
+   * Visit each item in @collection as lines inside a block delimited by braces
    * with increased indentation. Also includes special handling for empty
    * collection to print only the delimiters with no new line inside.
    */

                 reply	other threads:[~2023-02-21 12:00 UTC|newest]

Thread overview: [no followups] expand[flat|nested]  mbox.gz  Atom feed

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20230221120055.A5E9C384DD2D@sourceware.org \
    --to=cohenarthur@gcc.gnu.org \
    --cc=gcc-cvs@gcc.gnu.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).