diff options
| author | wiz <wiz@NetBSD.org> | 2004-11-24 12:26:23 +0000 |
|---|---|---|
| committer | wiz <wiz@NetBSD.org> | 2004-11-24 12:26:23 +0000 |
| commit | f91573afd7cc293b70514d6de755577a75e65d2f (patch) | |
| tree | 71cd54cf593a46e685f27fff63ac61104bc7b09d /lib/libform | |
| parent | 7b09170529187b8761196d9721e4832f13b71313 (diff) | |
Mark up NULL.
Diffstat (limited to 'lib/libform')
| -rw-r--r-- | lib/libform/form_cursor.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_driver.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_field.3 | 18 | ||||
| -rw-r--r-- | lib/libform/form_field_attributes.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_field_buffer.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_field_just.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_field_new.3 | 5 | ||||
| -rw-r--r-- | lib/libform/form_field_userptr.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_field_validation.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_fieldtype.3 | 12 | ||||
| -rw-r--r-- | lib/libform/form_hook.3 | 9 | ||||
| -rw-r--r-- | lib/libform/form_new.3 | 11 | ||||
| -rw-r--r-- | lib/libform/form_new_page.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_opts.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_page.3 | 9 | ||||
| -rw-r--r-- | lib/libform/form_post.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_userptr.3 | 6 | ||||
| -rw-r--r-- | lib/libform/form_win.3 | 14 |
18 files changed, 97 insertions, 47 deletions
diff --git a/lib/libform/form_cursor.3 b/lib/libform/form_cursor.3 index 9f6c390ba55..0b8034b3582 100644 --- a/lib/libform/form_cursor.3 +++ b/lib/libform/form_cursor.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_cursor.3,v 1.6 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_cursor.3,v 1.7 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -48,7 +48,9 @@ positions the screen cursor at the correct position for the form. This function can be used to restore the cursor state after using other curses routines. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_driver.3 b/lib/libform/form_driver.3 index 1eaabb0edd7..e25fda3fae4 100644 --- a/lib/libform/form_driver.3 +++ b/lib/libform/form_driver.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_driver.3,v 1.9 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_driver.3,v 1.10 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -183,7 +183,9 @@ Select the previous choice in an enumerated type field. Select the next choice in an enumerated type field. .El .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_field.3 b/lib/libform/form_field.3 index 9f01c0e789e..4943f466d84 100644 --- a/lib/libform/form_field.3 +++ b/lib/libform/form_field.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field.3,v 1.8 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -54,18 +54,24 @@ The .Fn field_count function returns the number of fields that are attached to the given -form, if the form argument passed is NULL then +form, if the form argument passed is +.Dv NULL +then .Fn field_count will return -1. The function .Fn form_fields will return a pointer to array of attach fields for the given form, -this array is not NULL terminated, fields may be attached to the given +this array is not +.Dv NULL +terminated, fields may be attached to the given form by calling .Fn set_form_fields . The .Fa fields -argument in this function is a pointer to a NULL terminated array of +argument in this function is a pointer to a +.Dv NULL +terminated array of fields that will be attached to the form. If there are already fields attached to the form then they will be detached before the new fields are attached. @@ -77,7 +83,9 @@ function will move the given field to the location specified by and .Fa fcol . .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_field_attributes.3 b/lib/libform/form_field_attributes.3 index 54ed9bbfdee..82fe22ea380 100644 --- a/lib/libform/form_field_attributes.3 +++ b/lib/libform/form_field_attributes.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_attributes.3,v 1.8 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field_attributes.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -78,7 +78,9 @@ function, the pad character is set by using the .Fn set_field_pad function. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_field_buffer.3 b/lib/libform/form_field_buffer.3 index cb7c37d1780..6ba638b98f2 100644 --- a/lib/libform/form_field_buffer.3 +++ b/lib/libform/form_field_buffer.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_buffer.3,v 1.10 2004/11/24 12:09:13 wiz Exp $ +.\" $NetBSD: form_field_buffer.3,v 1.11 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -61,7 +61,9 @@ function returns the contents of the buffer number specified by .Fa buffer for the given field. If the requested buffer number exceeds the -number of buffers attached to the field then NULL will be returned. +number of buffers attached to the field then +.Dv NULL +will be returned. If the field option .Dv O_REFORMAT is enabled on the given field then diff --git a/lib/libform/form_field_just.3 b/lib/libform/form_field_just.3 index 2767d237c4a..11d2f35a545 100644 --- a/lib/libform/form_field_just.3 +++ b/lib/libform/form_field_just.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_just.3,v 1.8 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field_just.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -75,7 +75,9 @@ The field will be centre justified, padding will be applied to either end of the line to make the line centred in the field. .El .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_field_new.3 b/lib/libform/form_field_new.3 index f196494a899..3c9bd58f694 100644 --- a/lib/libform/form_field_new.3 +++ b/lib/libform/form_field_new.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_new.3,v 1.9 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field_new.3,v 1.10 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -92,7 +92,8 @@ On error .Fn dup_field and .Fn new_field -will return NULL. +will return +.Dv NULL . The functions will one of the following error values: .Pp diff --git a/lib/libform/form_field_userptr.3 b/lib/libform/form_field_userptr.3 index 86d99cbf19e..ee1aaf9aff8 100644 --- a/lib/libform/form_field_userptr.3 +++ b/lib/libform/form_field_userptr.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_userptr.3,v 1.7 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field_userptr.3,v 1.8 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -52,7 +52,9 @@ this pointer may be set by calling the .Fn set_field_userptr function. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_field_validation.3 b/lib/libform/form_field_validation.3 index 4d8f03ea609..b4619b2671b 100644 --- a/lib/libform/form_field_validation.3 +++ b/lib/libform/form_field_validation.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_field_validation.3,v 1.8 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_field_validation.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -60,7 +60,9 @@ field, this type can be set by calling the function which associates the given field type with the field, the third and subsequent parameters are field dependent arguments. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_fieldtype.3 b/lib/libform/form_fieldtype.3 index bb474ae9ede..6806ac876f6 100644 --- a/lib/libform/form_fieldtype.3 +++ b/lib/libform/form_fieldtype.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_fieldtype.3,v 1.8 2004/11/24 12:12:19 wiz Exp $ +.\" $NetBSD: form_fieldtype.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -89,7 +89,8 @@ Neither .Fa field_check nor .Fa char_check -may be NULL. +may be +.Dv NULL . The functions for handling the field type arguments can be defined by using the .Fn set_fieldtype_arg @@ -101,7 +102,8 @@ is used to copy the fieldtype arguments to a new arguments structure and .Fa free_args is used to destroy the fieldtype arguments and release any associated -storage, none of these function pointers may be NULL. +storage, none of these function pointers may be +.Dv NULL . The field type choice functions can be set by calling .Fn set_fieldtype_choice , the @@ -115,7 +117,9 @@ necessary. The choice functions must return TRUE if the function succeeded and FALSE otherwise. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_hook.3 b/lib/libform/form_hook.3 index e0b19ab5f23..bf7cd0ddaff 100644 --- a/lib/libform/form_hook.3 +++ b/lib/libform/form_hook.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_hook.3,v 1.8 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_hook.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -91,9 +91,12 @@ just after the form is unposted from the screen, this function may be set by using the .Fn set_form_term function. -By default, the init and term function pointers are NULL. +By default, the init and term function pointers are +.Dv NULL . .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_new.3 b/lib/libform/form_new.3 index a5e90546f7b..c547c1e8faa 100644 --- a/lib/libform/form_new.3 +++ b/lib/libform/form_new.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_new.3,v 1.7 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_new.3,v 1.8 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -55,10 +55,13 @@ will create a new form, set the form parameters to the current defaults and attach the passed fields to the form. The array of fields passed to .Fn new_form -must be terminated with a NULL pointer to indicate the end of the -fields. +must be terminated with a +.Dv NULL +pointer to indicate the end of the fields. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_new_page.3 b/lib/libform/form_new_page.3 index 338ac58cf35..a37272f7862 100644 --- a/lib/libform/form_new_page.3 +++ b/lib/libform/form_new_page.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_new_page.3,v 1.7 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_new_page.3,v 1.8 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -53,7 +53,9 @@ or unset using the .Fn set_new_page function. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_opts.3 b/lib/libform/form_opts.3 index a29fdd0d919..bc6d145dcac 100644 --- a/lib/libform/form_opts.3 +++ b/lib/libform/form_opts.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_opts.3,v 1.8 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_opts.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -82,7 +82,9 @@ REQ_NEXT_FIELD driver request, moving to the next field in the form. .Pp By default no form options are set. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_page.3 b/lib/libform/form_page.3 index a42affd673f..64898067a2e 100644 --- a/lib/libform/form_page.3 +++ b/lib/libform/form_page.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_page.3,v 1.8 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_page.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 1999 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -63,7 +63,8 @@ returns a pointer to the structure for the field that is currently active on the page. If there is an error, .Fn current_field -will return NULL. +will return +.Dv NULL . Calling .Fn field_index will return the index of the given field in the form field array. @@ -82,7 +83,9 @@ The current field on the form may be set by calling .Fn set_current_field which will set the current field to the one given. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_post.3 b/lib/libform/form_post.3 index deca7ef28e5..c4ad059bfcf 100644 --- a/lib/libform/form_post.3 +++ b/lib/libform/form_post.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_post.3,v 1.7 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_post.3,v 1.8 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -57,7 +57,9 @@ Conversely, the function removes the form from the screen and calls any termination functions that were specified. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_userptr.3 b/lib/libform/form_userptr.3 index 21027bf8130..273d54b4077 100644 --- a/lib/libform/form_userptr.3 +++ b/lib/libform/form_userptr.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_userptr.3,v 1.7 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_userptr.3,v 1.8 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -52,7 +52,9 @@ the form, this pointer may be set using the .Fn set_form_userptr call. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp diff --git a/lib/libform/form_win.3 b/lib/libform/form_win.3 index 86af40b9015..83febef9299 100644 --- a/lib/libform/form_win.3 +++ b/lib/libform/form_win.3 @@ -1,4 +1,4 @@ -.\" $NetBSD: form_win.3,v 1.8 2004/11/24 12:12:20 wiz Exp $ +.\" $NetBSD: form_win.3,v 1.9 2004/11/24 12:26:23 wiz Exp $ .\" .\" Copyright (c) 2001 .\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au @@ -69,17 +69,23 @@ If a subwindow has been specified using then it will be used by the forms library to for screen output. The current setting for the form window can be retrieved by calling .Fn form_win . -If the forms window has not been set then NULL will be returned. +If the forms window has not been set then +.Dv NULL +will be returned. Similarly, the forms subwindow can be found by calling the .Fn form_sub -function, again, if the subwindow has not been set then NULL will be +function, again, if the subwindow has not been set then +.Dv NULL +will be returned. The .Fn scale_form function will return the minimum number of rows and columns that will entirely contain the given form. .Sh RETURN VALUES -Functions returning pointers will return NULL if an error is detected. +Functions returning pointers will return +.Dv NULL +if an error is detected. The functions that return an int will return one of the following error values: .Pp |
