Changeset 6457 for trunk/doc/pslib/psLibSDRS.tex

Timestamp:

Feb 21, 2006, 2:11:07 PM (20 years ago)

Author:

jhoblitt

Message:

allow psMetadataItem pointer types to have a value of NULL

File:

• trunk/doc/pslib/psLibSDRS.tex (modified) (2 diffs)

trunk/doc/pslib/psLibSDRS.tex

@@ -1 @@
-%%% $Id: psLibSDRS.tex,v 1.384 2006-02-22 00:02:00 eugene Exp $
+%%% $Id: psLibSDRS.tex,v 1.385 2006-02-22 00:11:07 jhoblitt Exp $
 \documentclass[panstarrs,spec]{panstarrs}
 
@@ -2665 +2665 @@
 \end{prototype}
 
-The allocator for \code{psMetadataItem} returns a full
-\code{psMetadataItem} ready for insertion into the \code{psMetadata}.
-The \code{name} entry specifies the name to use for this metadata
-item, and may include \code{sprintf}-type formating codes.  The
-\code{comment} entry is a fixed string which is used for the comment
-associated with this metadata item.  The metadata data and the
-arguments to the \code{name} formatting codes are passed, in that
-order (metadata pointer first), to \code{psMetadataItemAlloc} as
-arguments following the comment string.  The data must be a pointer
-for any data types which are stored in the element \code{data.void},
-while other data types are passed as numeric values.  The argument
-list must be interpreted appropriately by the \code{va_list} operators
-in the function.
+The allocator for \code{psMetadataItem} returns a full \code{psMetadataItem}
+ready for insertion into the \code{psMetadata}.  The \code{name} entry
+specifies the name to use for this metadata item, and may include
+\code{sprintf}-type formating codes.  The \code{comment} entry is a fixed
+string which is used for the comment associated with this metadata item.  The
+metadata data and the arguments to the \code{name} formatting codes are passed,
+in that order (metadata pointer first), to \code{psMetadataItemAlloc} as
+arguments following the comment string.  The data must be a pointer for any
+data types which are stored in the element \code{data.void}, while other data
+types are passed as numeric values.  All \code{data.void} types may be set to
+have a value of \code{NULL}.  The argument list must be interpreted
+appropriately by the \code{va_list} operators in the function.
 
 \begin{prototype}