bug-ncurses
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[PATCH 030/177] man/curs_getcchar.3x: Revise "SYNOPSIS" section.


From: G. Branden Robinson
Subject: [PATCH 030/177] man/curs_getcchar.3x: Revise "SYNOPSIS" section.
Date: Mon, 13 Jan 2025 11:19:05 -0600

* Put a space after pointer stars in function synopses, for consistency
  with other recently edited ncurses man pages.
* Use *roff font selection escape sequences exclusively to set the
  synopses, for consistency with other ncurses man pages.
* Fill lines of function synopses as is done in other ncurses man pages,
  instead of setting one formal parameter per line.  But also...
* Break long synopses across lines where they exceed 65 columns on nroff
  devices.  This was the line length used by AT&T troff (and BSD troff
  until they adopted groff in their Net/2 release), and is, in my
  opinion, the minimum line length one can expect to look nice.  groff
  1.24 is expected to feature enhanced `SY`/`YS` macros that work as
  well with C function declarations as command-line syntax.  Perhaps we
  can inline their definitions in the ncurses man pages (which need to
  be portable to legacy Unix systems) after they've seen more field
  testing.
---
 man/curs_getcchar.3x | 18 +++++-------------
 1 file changed, 5 insertions(+), 13 deletions(-)

diff --git a/man/curs_getcchar.3x b/man/curs_getcchar.3x
index 523cc99df..9b44944e5 100644
--- a/man/curs_getcchar.3x
+++ b/man/curs_getcchar.3x
@@ -41,19 +41,11 @@ .SH SYNOPSIS
 .nf
 \fB#include <curses.h>
 .PP
-\fBint getcchar(
-.B "        const cchar_t *\fIwch\fP,"
-.B "        wchar_t *\fIwc\fP,"
-.B "        attr_t *\fIattrs\fP,"
-.B "        short *\fIcolor_pair\fP,"
-.B "        void *\fIopts\fP );"
-.PP
-.B "int setcchar("
-.B "        cchar_t *\fIwch\fP,"
-.B "        const wchar_t *\fIwc\fP,"
-.B "        const attr_t \fIattrs\fP,"
-.B "        short \fIcolor_pair\fP,"
-.B "        const void *\fIopts\fP );"
+\fBint gettchar(const cchar_t * \fIwch\fP, wchar_t * \fIwc\fP,
+      attr_t * \fIattrs\fP, short * \fIcolor_pair\fP, void * \fIopts\fP);
+\fBint settchar(cchar_t * \fIwch\fP, const wchar_t * \fIwc\fP,
+      const attr_t * \fIattrs\fP, short * \fIcolor_pair\fP,
+      const void * \fIopts\fP);
 .fi
 .SH DESCRIPTION
 .SS getcchar
-- 
2.30.2

Attachment: signature.asc
Description: PGP signature


reply via email to

[Prev in Thread] Current Thread [Next in Thread]