Re issue #138 - Added some Doxygen comments for the API #174
Conversation
eyalroz
changed the title
eyalroz
changed the title
|
Can one of the admins verify this patch? |
|
@GPUtester : If somebody started to do that, they need to restart, since I just amended the commit myself after finding some typos. |
|
Is this coordinated with prior work being done here? #156 |
include/gdf/cffi/types.h
Outdated
| GDF_DATE32, /**< int32_t days since the UNIX epoch */ | ||
| GDF_DATE64, /**< int64_t milliseconds since the UNIX epoch */ | ||
| GDF_TIMESTAMP, /**< Exact timestamp encoded with int64 since UNIX epoch (Default unit millisecond) */ | ||
| GDF_DATE32, /// int32_t days since the UNIX epoch |
There was a problem hiding this comment.
Putting a comment on the same line, as in for a data member or enum requires <.
There was a problem hiding this comment.
Ok, I'll fix it. The Eclipse Doxygen plugin accepts just /// without the < as a marker of a same-line comment.
Not as such, no. As a relative newcomer to BlazingDB, I wanted to clear things up for myself about the API - now that I'm going to use it or add to it. I picked @felipeblazing 's brain about some of the API, and read the sources for other parts of it, and this was the result. |
|
@jrhemstad : I've replaced the |
| ///< @todo Is this always in device memory? | ||
|
|
||
| gdf_valid_type *valid; | ||
| ///< a pseudo-column of `size` bits, packed into bytes (with in-byte order from |
There was a problem hiding this comment.
More detail about the bit/byte ordering of the valid mask would be useful for new developers. See the Apache Arrow description of this ordering here: https://arrow.apache.org/docs/memory_layout.html
include/gdf/cffi/types.h
Outdated
|
|
||
| gdf_size_type null_count; | ||
| ///< The number of null elements in the column, which is | ||
| ///< also the number of 1 bits in the `valid` pseudo-column |
There was a problem hiding this comment.
null_count would be the number of 0 bits in the range [0, size).
There was a problem hiding this comment.
@jrhemstad : Right, fixed.
* Added doxygen comments for many data types and functions in the library's API. * Made some existing doxygen comments conform better to the doxygen documentation template (see issue #198) * Minor spacing, spelling and formatting tweaks
Following the discussion on issue 138, here's a hopefully-template-compliant PR adding documentation to some API functions and data types (not all of them).
There are other some minor tweaks such as removal of some
/* ---- */s, spelling and rephrasing.