summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThomas E. Dickey <dickey@invisible-island.net>2021-03-16 19:34:51 -0400
committerThomas E. Dickey <dickey@invisible-island.net>2021-03-17 19:10:17 -0400
commitbacd41c0c068c5f55b635a4887b4185ad2e3ea10 (patch)
tree96f6200af879efbf691314c80bda825d7b142a51
parent821254578e15440d2177fff0b61f73590ae29869 (diff)
document the cursor-comments functions
Signed-off-by: Thomas E. Dickey <dickey@invisible-island.net>
-rw-r--r--man/Makefile.am4
-rw-r--r--man/Xcursor.man33
-rw-r--r--man/XcursorCommentCreate.man1
-rw-r--r--man/XcursorCommentDestroy.man1
-rw-r--r--man/XcursorCommentsCreate.man1
-rw-r--r--man/XcursorCommentsDestroy.man1
6 files changed, 41 insertions, 0 deletions
diff --git a/man/Makefile.am b/man/Makefile.am
index d998eeb..95e28ab 100644
--- a/man/Makefile.am
+++ b/man/Makefile.am
@@ -8,6 +8,10 @@ Xcursor_shadows = \
XcursorAnimateCreate \
XcursorAnimateDestroy \
XcursorAnimateNext \
+ XcursorCommentCreate \
+ XcursorCommentDestroy \
+ XcursorCommentsCreate \
+ XcursorCommentsDestroy \
XcursorCursorsCreate \
XcursorCursorsDestroy \
XcursorFileLoad \
diff --git a/man/Xcursor.man b/man/Xcursor.man
index a366312..d5450f6 100644
--- a/man/Xcursor.man
+++ b/man/Xcursor.man
@@ -546,6 +546,39 @@ XcursorCursors *XcursorShapeLoadCursors (
.NE
These map \fIshape\fP to a library name and then load the cursors.
.
+.SS X Cursor Comment APIs
+.NS
+XcursorComment *XcursorCommentCreate (
+ XcursorUInt comment_type,
+ int length)
+.NE
+XcursorXcFileLoad uses this function to allocate an XcursorComment
+structure for a single cursor.
+The \fIcomment_type\fP parameter is used as the \fIsubtype\fP field,
+e.g., COPYRIGHT.
+The \fIlength\fP is the number of bytes to allocate for the comment text.
+.
+.NS
+void XcursorCommentDestroy(
+ XcursorComment *comment)
+.NE
+Deallocates the given XcursorComment structure.
+.
+.NS
+XcursorComments * XcursorCommentsCreate (
+ int size)
+.NE
+XcursorXcFileLoad uses this function to allocate an index of
+XcursorComment structure pointers.
+The \fIsize\fP parameter tells it how many pointers will be in the index.
+.
+.NS
+void XcursorCommentsDestroy (
+ XcursorComments *comments)
+.NE
+Deallocates the given XcursorComments structure
+as well as the XcursorComment structures which it points to.
+.
.SS Animated Cursors
.NS
XcursorAnimate * XcursorAnimateCreate (
diff --git a/man/XcursorCommentCreate.man b/man/XcursorCommentCreate.man
new file mode 100644
index 0000000..690dab2
--- /dev/null
+++ b/man/XcursorCommentCreate.man
@@ -0,0 +1 @@
+.so man__libmansuffix__/Xcursor.__libmansuffix__
diff --git a/man/XcursorCommentDestroy.man b/man/XcursorCommentDestroy.man
new file mode 100644
index 0000000..690dab2
--- /dev/null
+++ b/man/XcursorCommentDestroy.man
@@ -0,0 +1 @@
+.so man__libmansuffix__/Xcursor.__libmansuffix__
diff --git a/man/XcursorCommentsCreate.man b/man/XcursorCommentsCreate.man
new file mode 100644
index 0000000..690dab2
--- /dev/null
+++ b/man/XcursorCommentsCreate.man
@@ -0,0 +1 @@
+.so man__libmansuffix__/Xcursor.__libmansuffix__
diff --git a/man/XcursorCommentsDestroy.man b/man/XcursorCommentsDestroy.man
new file mode 100644
index 0000000..690dab2
--- /dev/null
+++ b/man/XcursorCommentsDestroy.man
@@ -0,0 +1 @@
+.so man__libmansuffix__/Xcursor.__libmansuffix__