[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[PATCH 29/34] Make function synopses consistent with others.
From: |
G. Branden Robinson |
Subject: |
[PATCH 29/34] Make function synopses consistent with others. |
Date: |
Fri, 6 Oct 2023 00:18:01 -0500 |
Stop placing spaces immediately within parentheses.
Changing typefaces to set a space doesn't make a lot of sense in *roff.
Remember to return from italics to bold after setting a metasyntactic
variable.
Fix inconsistently wrapped line.
Don't change fonts from a face to the same face; doing so makes `\fP`
less reliable.
Fix oversight: the "event" argument in getmouse_sp() and ungetmouse_sp()
should be in italics, not bold. In the latter function, the data type
should also be preceded by a space (after a comma). Fix these.
Fix similar mistakes in mvcur() [curs_terminfo.3x] and scale_menu()
[menu_win.3x].
Spell pointer-to-MEVENT type without a space after "MEVENT" for
consistency.[1]
These changes prepare the pages for further sed-driven cleanup.
* man/curs_add_wch.3x:
* man/curs_add_wchstr.3x:
* man/curs_addstr.3x:
* man/curs_bkgd.3x:
* man/curs_bkgrnd.3x:
* man/curs_border_set.3x:
* man/curs_in_wchstr.3x:
* man/curs_inwstr.3x:
* man/curs_sp_funcs.3x:
* man/curs_terminfo.3x:
* man/menu_win.3x: Do it.
[1] However, pointers to void or const char tend to get a space before
`*` because...?
Oh, it gets better. Check these out.
FORM* new_form_sp(SCREEN* sp, FIELD **fields);
MENU* new_menu_sp(SCREEN* sp, ITEM **items);
---
man/curs_add_wch.3x | 12 ++++++------
man/curs_add_wchstr.3x | 4 ++--
man/curs_addstr.3x | 2 +-
man/curs_bkgd.3x | 2 +-
man/curs_bkgrnd.3x | 6 +++---
man/curs_border_set.3x | 3 +--
man/curs_in_wchstr.3x | 2 +-
man/curs_inwstr.3x | 16 ++++++++--------
man/curs_sp_funcs.3x | 4 ++--
man/curs_terminfo.3x | 2 +-
man/menu_win.3x | 2 +-
11 files changed, 27 insertions(+), 28 deletions(-)
diff --git a/man/curs_add_wch.3x b/man/curs_add_wch.3x
index d9e8e129..e927fac2 100644
--- a/man/curs_add_wch.3x
+++ b/man/curs_add_wch.3x
@@ -56,17 +56,17 @@ .SH NAME
.SH SYNOPSIS
\fB#include <curses.h>\fP
.sp
-.B "int add_wch( const cchar_t *\fIwch\fB );"
+\fBint add_wch(const cchar_t *\fIwch\fB);\fR
.br
-.B "int wadd_wch( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );"
+\fBint wadd_wch(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB);\fR
.br
-.B "int mvadd_wch( int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB );"
+\fBint mvadd_wch(int \fIy\fP, int \fIx\fP, const cchar_t *\fIwch\fB);\fR
.br
-.B "int mvwadd_wch( WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t
*\fIwch\fB );"
+\fBint mvwadd_wch(WINDOW *\fIwin\fP, int \fIy\fP, int \fIx\fP, const cchar_t
*\fIwch\fB);\fR
.sp
-.B "int echo_wchar( const cchar_t *\fIwch\fB );"
+\fBint echo_wchar(const cchar_t *\fIwch\fB);\fR
.br
-.B "int wecho_wchar( WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB );"
+\fBint wecho_wchar(WINDOW *\fIwin\fP, const cchar_t *\fIwch\fB);\fR
.SH DESCRIPTION
.SS add_wch
The
diff --git a/man/curs_add_wchstr.3x b/man/curs_add_wchstr.3x
index 201bfe1d..1e4918f6 100644
--- a/man/curs_add_wchstr.3x
+++ b/man/curs_add_wchstr.3x
@@ -62,9 +62,9 @@ .SH SYNOPSIS
.br
\fBint add_wchnstr(const cchar_t *\fIwchstr\fB, int \fIn\fB);\fR
.br
-\fBint wadd_wchstr(WINDOW *\fR \fIwin\fB, const cchar_t *\fIwchstr\fB);\fR
+\fBint wadd_wchstr(WINDOW * \fIwin\fB, const cchar_t *\fIwchstr\fB);\fR
.br
-\fBint wadd_wchnstr(WINDOW *\fR \fIwin\fB, const cchar_t *\fIwchstr\fB, int
\fIn\fB);\fR
+\fBint wadd_wchnstr(WINDOW * \fIwin\fB, const cchar_t *\fIwchstr\fB, int
\fIn\fB);\fR
.sp
\fBint mvadd_wchstr(int \fIy\fB, int \fIx\fB, const cchar_t *\fIwchstr\fB);\fR
.br
diff --git a/man/curs_addstr.3x b/man/curs_addstr.3x
index aabb95e5..1343fbec 100644
--- a/man/curs_addstr.3x
+++ b/man/curs_addstr.3x
@@ -72,7 +72,7 @@ .SH SYNOPSIS
.br
\fBint mvwaddstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char
*\fIstr\fB);\fR
.br
-\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char
*\fIstr, int \fIn\fB);\fR
+\fBint mvwaddnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, const char
*\fIstr\fB, int \fIn\fB);\fR
.fi
.SH DESCRIPTION
These functions write the (null-terminated) character string
diff --git a/man/curs_bkgd.3x b/man/curs_bkgd.3x
index ac30e16d..1bbcb3fc 100644
--- a/man/curs_bkgd.3x
+++ b/man/curs_bkgd.3x
@@ -45,7 +45,7 @@ .SH SYNOPSIS
.PP
\fBvoid bkgdset(chtype \fIch\fB);\fR
.br
-\fBvoid wbkgdset(WINDOW *\fIwin, chtype \fIch\fB);\fR
+\fBvoid wbkgdset(WINDOW *\fIwin\fB, chtype \fIch\fB);\fR
.sp
\fBint bkgd(chtype \fIch\fB);\fR
.br
diff --git a/man/curs_bkgrnd.3x b/man/curs_bkgrnd.3x
index 227c6a20..35b8e669 100644
--- a/man/curs_bkgrnd.3x
+++ b/man/curs_bkgrnd.3x
@@ -44,11 +44,11 @@ .SH NAME
.SH SYNOPSIS
\fB#include <curses.h>\fR
.sp
-\fBint bkgrnd(\fBconst cchar_t *\fIwch\fB);\fR
+\fBint bkgrnd(const cchar_t *\fIwch\fB);\fR
.br
-\fBint wbkgrnd(\fBWINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
+\fBint wbkgrnd(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
.sp
-\fBvoid bkgrndset(const cchar_t *\fIwch\fR \fB);\fR
+\fBvoid bkgrndset(const cchar_t *\fIwch\fB);\fR
.br
\fBvoid wbkgrndset(WINDOW *\fIwin\fB, const cchar_t *\fIwch\fB);\fR
.sp
diff --git a/man/curs_border_set.3x b/man/curs_border_set.3x
index c7e8f401..00b43e53 100644
--- a/man/curs_border_set.3x
+++ b/man/curs_border_set.3x
@@ -59,8 +59,7 @@ .SH SYNOPSIS
\fBconst cchar_t *\fIls\fR, \fBconst cchar_t *\fIrs\fR,
\fBconst cchar_t *\fIts\fR, \fBconst cchar_t *\fIbs\fR,
\fBconst cchar_t *\fItl\fR, \fBconst cchar_t *\fItr\fR,
- \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fR
-\fB);\fP
+ \fBconst cchar_t *\fIbl\fR, \fBconst cchar_t *\fIbr\fB);\fR
.br
\fBint wborder_set(\fP
\fBWINDOW *win\fP,
diff --git a/man/curs_in_wchstr.3x b/man/curs_in_wchstr.3x
index 01e8a099..1919396e 100644
--- a/man/curs_in_wchstr.3x
+++ b/man/curs_in_wchstr.3x
@@ -67,7 +67,7 @@ .SH SYNOPSIS
.br
\fBint mvwin_wchstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t
*\fIwchstr\fB);\fR
.br
-\fBint mvwin_wchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t
*\fIwchstr\fR, int \fIn\fB);\fR
+\fBint mvwin_wchnstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, cchar_t
*\fIwchstr\fB, int \fIn\fB);\fR
.fi
.SH DESCRIPTION
These functions return an array of complex characters in \fIwchstr\fP,
diff --git a/man/curs_inwstr.3x b/man/curs_inwstr.3x
index 0dcf9ff3..f20bb732 100644
--- a/man/curs_inwstr.3x
+++ b/man/curs_inwstr.3x
@@ -53,21 +53,21 @@ .SH SYNOPSIS
.nf
\fB#include <curses.h> \fP
.sp
-\fBint inwstr(\fBwchar_t *\fIwstr\fB);\fR
+\fBint inwstr(wchar_t *\fIwstr\fB);\fR
.br
-\fBint innwstr(\fBwchar_t *\fIwstr\fB, int \fIn\fB);\fR
+\fBint innwstr(wchar_t *\fIwstr\fB, int \fIn\fB);\fR
.br
-\fBint winwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB);\fR
+\fBint winwstr(WINDOW *\fIwin\fB, wchar_t *\fIwstr\fB);\fR
.br
-\fBint winnwstr(\fBWINDOW *\fIwin\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR
+\fBint winnwstr(WINDOW *\fIwin\fB, wchar_t *\fIwstr\fB, int \fIn\fB);\fR
.sp
-\fBint mvinwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB);\fR
+\fBint mvinwstr(int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB);\fR
.br
-\fBint mvinnwstr(\fBint \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int
\fIn\fB);\fR
+\fBint mvinnwstr(int \fIy\fB, int \fIx\fB, wchar_t *\fIwstr\fB, int
\fIn\fB);\fR
.br
-\fBint mvwinwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t
*\fIwstr\fB);\fR
+\fBint mvwinwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t
*\fIwstr\fB);\fR
.br
-\fBint mvwinnwstr(\fBWINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t
*\fIwstr\fB, int \fIn\fB);\fR
+\fBint mvwinnwstr(WINDOW *\fIwin\fB, int \fIy\fB, int \fIx\fB, wchar_t
*\fIwstr\fB, int \fIn\fB);\fR
.fi
.SH DESCRIPTION
These routines return a string of \fBwchar_t\fP wide characters in \fIwstr\fP,
diff --git a/man/curs_sp_funcs.3x b/man/curs_sp_funcs.3x
index 4fb31909..3f08e2c6 100644
--- a/man/curs_sp_funcs.3x
+++ b/man/curs_sp_funcs.3x
@@ -74,7 +74,7 @@ .SH SYNOPSIS
\fBint flushinp_sp(SCREEN* \fIsp\fB);\fR
\fBint free_pair_sp(SCREEN* \fIsp\fB, int \fIpair\fB);\fR
\fBint get_escdelay_sp(SCREEN* \fIsp\fB);\fR
-\fBint getmouse_sp(SCREEN* \fIsp\fB, MEVENT* \fBevent\fB);\fR
+\fBint getmouse_sp(SCREEN* \fIsp\fB, MEVENT* \fIevent\fB);\fR
\fBWINDOW* getwin_sp(SCREEN* \fIsp\fB, FILE* \fIfilep\fB);\fR
\fBint halfdelay_sp(SCREEN* \fIsp\fB, int \fItenths\fB);\fR
\fBbool has_colors_sp(SCREEN* \fIsp\fB);\fR
@@ -161,7 +161,7 @@ .SH SYNOPSIS
\fBint typeahead_sp(SCREEN* \fIsp\fB, int \fIfd\fB);\fR
\fBint unget_wch_sp(SCREEN* \fIsp\fB, const wchar_t \fIwch\fB);\fR
\fBint ungetch_sp(SCREEN* \fIsp\fB, int \fIch\fB);\fR
-\fBint ungetmouse_sp(SCREEN* \fIsp\fB,MEVENT * \fBevent\fB);\fR
+\fBint ungetmouse_sp(SCREEN* \fIsp\fB, MEVENT* \fIevent\fB);\fR
\fBint use_default_colors_sp(SCREEN* \fIsp\fB);\fR
\fBvoid use_env_sp(SCREEN* \fIsp\fB, bool \fIbf\fB);\fR
\fBint use_legacy_coding_sp(SCREEN* \fIsp\fB, int \fIlevel\fB);\fR
diff --git a/man/curs_terminfo.3x b/man/curs_terminfo.3x
index d8e42e99..480c6f00 100644
--- a/man/curs_terminfo.3x
+++ b/man/curs_terminfo.3x
@@ -101,7 +101,7 @@ .SH SYNOPSIS
\fBint vid_puts(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB, int
(*\fIputc\fB)(int));\fR
\fBint vid_attr(attr_t \fIattrs\fB, short \fIpair\fB, void *\fIopts\fB);\fR
.PP
-\fBint mvcur(int \fIoldrow\fB, int \fIoldcol\fB, int \fInewrow\fR, int
\fInewcol\fB);\fR
+\fBint mvcur(int \fIoldrow\fB, int \fIoldcol\fB, int \fInewrow\fB, int
\fInewcol\fB);\fR
.PP
\fBint tigetflag(const char *\fIcapname\fB);\fR
\fBint tigetnum(const char *\fIcapname\fB);\fR
diff --git a/man/menu_win.3x b/man/menu_win.3x
index 292ab432..23a7cabd 100644
--- a/man/menu_win.3x
+++ b/man/menu_win.3x
@@ -43,7 +43,7 @@ .SH SYNOPSIS
.br
\fBWINDOW *menu_sub(const MENU *\fImenu\fB);\fR
.sp
-\fBint scale_menu(const MENU *\fImenu, int *\fIrows\fB, int *\fIcolumns);\fR
+\fBint scale_menu(const MENU *\fImenu\fB, int *\fIrows\fB, int
*\fIcolumns\fB);\fR
.SH DESCRIPTION
Every menu has an associated pair of \fBcurses\fP windows.
The menu window
--
2.30.2
signature.asc
Description: PGP signature
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [PATCH 29/34] Make function synopses consistent with others.,
G. Branden Robinson <=