summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorJoey Castillo <joeycastillo@utexas.edu>2021-12-20 19:51:57 -0600
committerJoey Castillo <joeycastillo@utexas.edu>2021-12-21 08:20:08 -0600
commit1a4612f25972621b6c2f5f3b477f55b815f4dc84 (patch)
tree153faa85c12524a3928e4eedfe8c07b5bb00a2c9
parent60fe9691917f7e40effc72b1b6c929f9ba0ba3ee (diff)
downloadSensor-Watch-1a4612f25972621b6c2f5f3b477f55b815f4dc84.tar.gz
Sensor-Watch-1a4612f25972621b6c2f5f3b477f55b815f4dc84.tar.bz2
Sensor-Watch-1a4612f25972621b6c2f5f3b477f55b815f4dc84.zip
add documentation for watch face index
-rw-r--r--movement/movement.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/movement/movement.h b/movement/movement.h
index 5431436b..edb1fabc 100644
--- a/movement/movement.h
+++ b/movement/movement.h
@@ -114,6 +114,9 @@ extern const char movement_valid_position_1_chars[];
* @param settings A pointer to the global Movement settings. You can use this to inform how you present your
* display to the user (i.e. taking into account whether they have silenced the buttons, or if
* they prefer 12 or 24-hour mode). You can also change these settings if you like.
+ * @param watch_face_index The index of this watch face in the global array of watch faces; 0 is the first face,
+ * 1 is the second, etc. You may stash this value in your context if you wish to reference
+ * it later; your watch face's index is set at launch and will not change.
* @param context_ptr A pointer to a pointer; at first invocation, this value will be NULL, and you can set it
* to any value you like. Subsequent invocations will pass in whatever value you previously
* set. You may want to check if this is NULL and if so, allocate some space to store any