Skip to content

Commit 70707c1

Browse files
committed
docs: minor doc fixes gh-137
1 parent 0707221 commit 70707c1

File tree

1 file changed

+9
-2
lines changed

1 file changed

+9
-2
lines changed

include/asdf/core/datatype.h

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,14 @@ typedef enum {
4747
ASDF_DATATYPE_COMPLEX64,
4848
ASDF_DATATYPE_COMPLEX128,
4949
ASDF_DATATYPE_BOOL8,
50+
/** ASCII text datatype */
5051
ASDF_DATATYPE_ASCII,
52+
/**
53+
* UCS4 Unicode datatype
54+
*
55+
* When using this datatype in `asdf_datatype_t` make sure to set the
56+
* ``.size`` field to 4 * the string field length in characters.
57+
*/
5158
ASDF_DATATYPE_UCS4,
5259
/**
5360
* Indicates that a datatype is non-scalar / is a compound-type/structured array
@@ -147,10 +154,10 @@ ASDF_EXPORT const char *asdf_scalar_datatype_to_string(asdf_scalar_datatype_t da
147154
/**
148155
* Get the size of an `asdf_datatype_t` in bytes
149156
*
150-
* This is equivalent to looking up the public field `asdf_datatype_t.size`.
157+
* This is equivalent to looking up the public field ``asdf_datatype_t.size``.
151158
* However, the difference is that for user-defined datatypes it is not
152159
* required to set the size explicitly--in that case this computes, sets, and
153-
* returns `asdf_datatype_t.size`.
160+
* returns ``asdf_datatype_t.size``.
154161
*
155162
* The exception is that for string datatypes (`ASDF_DATATYPE_ASCII` and
156163
* `ASDF_DATATYPE_UCS4`) the user *must* provide the correct size, and a size

0 commit comments

Comments
 (0)