[src/trunk]: src/usr.bin/indent indent: document the comment buffer more accu...

[rillig <rillig%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/843b80d3f183
branches:  trunk
changeset: 991099:843b80d3f183
user:      rillig <rillig%NetBSD.org@localhost>
date:      Sun Nov 07 13:43:11 2021 +0000

description:
indent: document the comment buffer more accurately

diffstat:

 usr.bin/indent/indent.h |  6 ++++--
 1 files changed, 4 insertions(+), 2 deletions(-)

diffs (20 lines):

diff -r 8e3421ff9730 -r 843b80d3f183 usr.bin/indent/indent.h
--- a/usr.bin/indent/indent.h   Sun Nov 07 13:38:32 2021 +0000
+++ b/usr.bin/indent/indent.h   Sun Nov 07 13:43:11 2021 +0000
@@ -1,4 +1,4 @@
-/*     $NetBSD: indent.h,v 1.82 2021/11/07 08:24:50 rillig Exp $       */
+/*     $NetBSD: indent.h,v 1.83 2021/11/07 13:43:11 rillig Exp $       */
 
 /*-
  * SPDX-License-Identifier: BSD-2-Clause-FreeBSD
@@ -159,7 +159,9 @@
 extern struct buffer lab;      /* the label or preprocessor directive */
 extern struct buffer code;     /* the main part of the current line of code */
 extern struct buffer com;      /* the trailing comment of the line, or the
-                                * start or end of a multi-line comment */
+                                * start or end of a multi-line comment, or
+                                * while in process_comment, a single line of
+                                * a multi-line comment */
 
 extern char sc_buf[sc_size];   /* input text is saved here when looking for
                                 * the brace after an if, while, etc */