diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2022-08-26 18:29:05 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2022-08-27 10:12:44 -0700 |
commit | 2d5fa4c2079494f502f9a576d749fa1e205f2144 (patch) | |
tree | 5f4bcab7f2ad1fb911380f1d50caf67988daec9d | |
parent | 2b7357e83e38e2a860687ee4150ef60bd6c0a47f (diff) |
man pages: Add missing word 'function' where needed
A number of instances of 'The Xpm... function' were missing the word
"function", so read awkwardly.
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | man/XpmCreateBuffer.man | 7 | ||||
-rw-r--r-- | man/XpmCreateImage.man | 2 | ||||
-rw-r--r-- | man/XpmCreateXpmImage.man | 2 | ||||
-rw-r--r-- | man/XpmMisc.man | 6 |
4 files changed, 9 insertions, 8 deletions
diff --git a/man/XpmCreateBuffer.man b/man/XpmCreateBuffer.man index cd3062b..44c0063 100644 --- a/man/XpmCreateBuffer.man +++ b/man/XpmCreateBuffer.man @@ -58,18 +58,19 @@ The XpmCreateBufferFromPixmap function works as XpmWriteFileFromPixmap(), it jus XpmCreateBufferFromImage instead of XpmWriteFileFromImage. Once again, the caller should free the buffer using XpmFree when finished. -As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer are provided to copy a file to a buffer +As a convenience, the XpmReadFileToBuffer and XpmWriteFileFromBuffer functions +are provided to copy a file to a buffer and to write a file from a buffer. Thus for instance one may decide to use XpmReadFileToBuffer, XpmCreatePixmapFromBuffer, and XpmFree instead of XpmReadFileToPixmap. On some systems this may lead to a performance improvement, since the parsing will be performed in memory, but it uses more memory. .SS XpmCreateBufferFromImage -The XpmCreateBufferFromImage works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file. +The XpmCreateBufferFromImage function works as XpmWriteFileFromImage(), it just writes to a malloc’ed buffer instead of to a file. The caller should free the buffer using XpmFree when finished. .SS XpmCreateBufferFromXpmImage. To create an XPM buffer from an XpmImage, use XpmCreateBufferFromXpmImage. -The XpmCreateBufferFromXpmImage writes out the givenimage to a single block malloc’ed buffer inXPM format. +The XpmCreateBufferFromXpmImage function writes out the givenimage to a single block malloc’ed buffer inXPM format. If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success. If the passed XpmInfo structure pointer is not NULL, XpmCreateBufferFromXpmImage looks for the following attributes: XpmComments, XpmExtensions, and XpmHotspot, and writes the related information out as well. diff --git a/man/XpmCreateImage.man b/man/XpmCreateImage.man index 28c9bf7..024a29e 100644 --- a/man/XpmCreateImage.man +++ b/man/XpmCreateImage.man @@ -63,7 +63,7 @@ and possibly the data returned into the XpmAttributes structure. .SS XpmCreateImageFromBuffer To create an XImage from an XPM buffer, use XpmCreateImageFromBuffer. -The XpmCreateImageFromBuffer works the same way as XpmReadFileToImage(), +The XpmCreateImageFromBuffer function works the same way as XpmReadFileToImage(), it just parses the buffer instead of the file. Be aware that the feature provided on some systems by XpmReadFileToImage to deal with compressed files is not available here. diff --git a/man/XpmCreateXpmImage.man b/man/XpmCreateXpmImage.man index 09bf577..692ac48 100644 --- a/man/XpmCreateXpmImage.man +++ b/man/XpmCreateXpmImage.man @@ -59,7 +59,7 @@ Specifies the location of a structure containing information (or NULL). .SH DESCRIPTION .SS XpmCreateXpmImageFromBuffer To create an XpmImage from an XPM buffer, use XpmCreateXpmImageFromBuffer. -The XpmCreateXpmImageFromBuffer reads the given buffer to fill in the given XpmImage structure. +The XpmCreateXpmImageFromBuffer function reads the given buffer to fill in the given XpmImage structure. If the buffer does not contain valid XPM data, it returns XpmFileInvalid. If insufficient working storage is allocated, it returns XpmNoMemory, and returns XpmSuccess on success. If the passed XpmInfo structure pointer is not NULL, XpmCreateXpmImageFromBuffer looks for the following attributes: diff --git a/man/XpmMisc.man b/man/XpmMisc.man index a447e27..3fed6dd 100644 --- a/man/XpmMisc.man +++ b/man/XpmMisc.man @@ -65,7 +65,7 @@ Specifies the structure to free .SH DESCRIPTION To free possible data stored into an XpmImage structure use XpmFreeXpmImage. -The XpmFreeXpmImagefrees the structure members which are not NULL, but not the structure itself. +The XpmFreeXpmImage function frees the structure members which are not NULL, but not the structure itself. To free possible data stored into an XpmInfo structure use XpmFreeXpmInfo. To free data possibly stored into an array of XpmExtension use XpmFreeExtensions. @@ -76,7 +76,7 @@ XpmFree is nothing else than a define to the standard free. However since these functions may be redefined in specific environments it is wise to use XpmFree. To free possible data stored into an XpmAttributes structure use XpmFreeAtatributes. -The XpmFreeAttributes frees the structure members which have been malloc’ed such as the pixels list. +The XpmFreeAttributes function frees the structure members which have been malloc’ed such as the pixels list. To dynamically allocate an XpmAttributes structure use the XpmAttributesSize function. The XpmAttributesSize function provides application using dynamic libraries with a safe way to allocate and then @@ -85,7 +85,7 @@ compiled. To get data when building an error message, one can use XpmGetErrorString. XpmGetErrorString returns a string related to the given XPM error code. -The XpmLibraryVersion can be used when one needs to figure out which version of the library is in use. +The XpmLibraryVersion function can be used when one needs to figure out which version of the library is in use. The value returned by XpmLibraryVersion can be compared to the value of XpmIncludeVersion which is defined in the header file "xpm.h". These numbers are computed with the following formula: .nf |