Module Name: src
Committed By: wiz
Date: Wed Oct 28 10:22:40 UTC 2015
Modified Files:
src/lib/libpanel: move_panel.3 new_panel.3 panel.3 panel_above.3
panel_hidden.3
Log Message:
Improve wording.
To generate a diff of this commit:
cvs rdiff -u -r1.3 -r1.4 src/lib/libpanel/move_panel.3 \
src/lib/libpanel/panel_above.3
cvs rdiff -u -r1.2 -r1.3 src/lib/libpanel/new_panel.3 \
src/lib/libpanel/panel.3 src/lib/libpanel/panel_hidden.3
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/lib/libpanel/move_panel.3
diff -u src/lib/libpanel/move_panel.3:1.3 src/lib/libpanel/move_panel.3:1.4
--- src/lib/libpanel/move_panel.3:1.3 Wed Oct 28 10:18:54 2015
+++ src/lib/libpanel/move_panel.3 Wed Oct 28 10:22:40 2015
@@ -1,4 +1,4 @@
-.\" $NetBSD: move_panel.3,v 1.3 2015/10/28 10:18:54 wiz Exp $
+.\" $NetBSD: move_panel.3,v 1.4 2015/10/28 10:22:40 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
@@ -47,8 +47,9 @@ and
.Fa x
positions are the new origin of the panel on the screen.
.Pp
-This function is panel library counterpart of curses
-.Xr mvwin 3 .
+This function is the panel library counterpart of the curses
+.Xr mvwin 3
+function.
Curses
.Fn mvwin
must never be directly used on a window associated with a panel.
Index: src/lib/libpanel/panel_above.3
diff -u src/lib/libpanel/panel_above.3:1.3 src/lib/libpanel/panel_above.3:1.4
--- src/lib/libpanel/panel_above.3:1.3 Wed Oct 28 10:18:54 2015
+++ src/lib/libpanel/panel_above.3 Wed Oct 28 10:22:40 2015
@@ -1,4 +1,4 @@
-.\" $NetBSD: panel_above.3,v 1.3 2015/10/28 10:18:54 wiz Exp $
+.\" $NetBSD: panel_above.3,v 1.4 2015/10/28 10:22:40 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
@@ -51,7 +51,7 @@
.\"
.Sh DESCRIPTION
Newly created panels are placed at the top of the deck.
-Z-order of a visible panel can be changed with the functions
+The z-order of a visible panel can be changed with the functions
.Fn top_panel
and
.Fn bottom_panel
Index: src/lib/libpanel/new_panel.3
diff -u src/lib/libpanel/new_panel.3:1.2 src/lib/libpanel/new_panel.3:1.3
--- src/lib/libpanel/new_panel.3:1.2 Wed Oct 28 02:23:50 2015
+++ src/lib/libpanel/new_panel.3 Wed Oct 28 10:22:40 2015
@@ -1,4 +1,4 @@
-.\" $NetBSD: new_panel.3,v 1.2 2015/10/28 02:23:50 uwe Exp $
+.\" $NetBSD: new_panel.3,v 1.3 2015/10/28 10:22:40 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
@@ -56,15 +56,15 @@ creates a new panel associated with the
.Fa win .
The new panel is visible and is placed at the top of the deck.
.Pp
-Curses window associated with a panel may be obtained with
+The curses window associated with a panel may be obtained with
.Fn panel_window
and changed with
.Fn replace_panel .
.Pp
-The funcion
+The function
.Fn del_panel
hides the panel and deletes it.
-Note, that the curses window associated with the panel is not deleted.
+Note that the curses window associated with the panel is not deleted.
.Sh RETURN VALUES
Functions returning pointers will return
.Dv NULL
Index: src/lib/libpanel/panel.3
diff -u src/lib/libpanel/panel.3:1.2 src/lib/libpanel/panel.3:1.3
--- src/lib/libpanel/panel.3:1.2 Wed Oct 28 10:18:43 2015
+++ src/lib/libpanel/panel.3 Wed Oct 28 10:22:40 2015
@@ -1,4 +1,4 @@
-.\" $NetBSD: panel.3,v 1.2 2015/10/28 10:18:43 wiz Exp $
+.\" $NetBSD: panel.3,v 1.3 2015/10/28 10:22:40 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
@@ -36,6 +36,7 @@
.Sh DESCRIPTION
Overlapping curses windows have no notion of z-order,
what you see on the screen depends on the order of updates.
+The
.Nm
library is an extension built on top of
.Xr curses 3
@@ -49,8 +50,8 @@ Panels have z-order only relative to oth
stdscr.
The latter doesn't have a panel of its own but implicitly lies below
all other panels in the deck.
-If you mix plain curses windows and panels the visual results are
-undefined since panel library is not aware of windows that are not
+If you mix plain curses windows and panels, the visual results are
+undefined since the panel library is not aware of windows that are not
associated with panels.
.Bl -column ".Xr set_panel_userptr 3"
.It Sy "Function" Ta Sy "Summary"
Index: src/lib/libpanel/panel_hidden.3
diff -u src/lib/libpanel/panel_hidden.3:1.2 src/lib/libpanel/panel_hidden.3:1.3
--- src/lib/libpanel/panel_hidden.3:1.2 Wed Oct 28 02:23:50 2015
+++ src/lib/libpanel/panel_hidden.3 Wed Oct 28 10:22:40 2015
@@ -1,4 +1,4 @@
-.\" $NetBSD: panel_hidden.3,v 1.2 2015/10/28 02:23:50 uwe Exp $
+.\" $NetBSD: panel_hidden.3,v 1.3 2015/10/28 10:22:40 wiz Exp $
.\"
.\" Copyright (c) 2015 Valery Ushakov
.\" All rights reserved.
@@ -46,7 +46,7 @@
.Fn panel_hidden "PANEL *p"
.\"
.Sh DESCRIPTION
-Panels are initialy created visible.
+Panels are initially created visible.
The function
.Fn hide_panel
can be used to hide a panel.
@@ -56,7 +56,7 @@ A panel can be made visible again with a
.Fn show_panel .
The panel is returned to the top of the deck.
.Pp
-Current visibility status of a panel can be queried with
+The current visibility status of a panel can be queried with
.Fn panel_hidden .
.Sh IMPLEMENTATION NOTES
The
