FlapJackApps/libdivecomputer
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Add some documentation for the event values.

Browse Source 
For the new packed 16bit event values, some minimal documentation is
required to interpret the value correctly.
This commit is contained in:
Jef Driesen 2012-11-24 08:32:51 +01:00
parent 1d360d3a1e
commit e4b66048a6
1 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
include/libdivecomputer/parser.h
View File

@ -54,7 +54,10 @@ typedef enum dc_field_type_t {
typedef enum parser_sample_event_t { typedef enum parser_sample_event_t {
SAMPLE_EVENT_NONE, SAMPLE_EVENT_NONE,
SAMPLE_EVENT_DECOSTOP, SAMPLE_EVENT_DECOSTOP, /* The event value contains an optional decompression
depth (in meters) and time (in seconds), packed as
two 16bit integers in respectively the low and
high part. */
SAMPLE_EVENT_RBT, SAMPLE_EVENT_RBT,
SAMPLE_EVENT_ASCENT, SAMPLE_EVENT_ASCENT,
SAMPLE_EVENT_CEILING, SAMPLE_EVENT_CEILING,
@ -64,7 +67,7 @@ typedef enum parser_sample_event_t {
SAMPLE_EVENT_BOOKMARK, SAMPLE_EVENT_BOOKMARK,
SAMPLE_EVENT_SURFACE, SAMPLE_EVENT_SURFACE,
SAMPLE_EVENT_SAFETYSTOP, SAMPLE_EVENT_SAFETYSTOP,
SAMPLE_EVENT_GASCHANGE, SAMPLE_EVENT_GASCHANGE, /* The event value contains the O2 percentage. */
SAMPLE_EVENT_SAFETYSTOP_VOLUNTARY, SAMPLE_EVENT_SAFETYSTOP_VOLUNTARY,
SAMPLE_EVENT_SAFETYSTOP_MANDATORY, SAMPLE_EVENT_SAFETYSTOP_MANDATORY,
SAMPLE_EVENT_DEEPSTOP, SAMPLE_EVENT_DEEPSTOP,
@ -78,8 +81,11 @@ typedef enum parser_sample_event_t {
SAMPLE_EVENT_RGBM, SAMPLE_EVENT_RGBM,
SAMPLE_EVENT_HEADING, SAMPLE_EVENT_HEADING,
SAMPLE_EVENT_TISSUELEVEL, SAMPLE_EVENT_TISSUELEVEL,
SAMPLE_EVENT_GASCHANGE2, SAMPLE_EVENT_GASCHANGE2, /* The event value contains the O2 and He
SAMPLE_EVENT_NDL percentages, packed as two 16bit integers in
respectively the low and high part. */
SAMPLE_EVENT_NDL /* The event value contains an optional no decompression
time (in seconds). */
} parser_sample_event_t; } parser_sample_event_t;
typedef enum parser_sample_flags_t { typedef enum parser_sample_flags_t {