GNSS: Add comment regarding units for waitUpdate argument

sonydevworld · Feb 14, 2023 · 191f3c8 · 191f3c8
1 parent fb23d00
commit 191f3c8
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 2 deletions.
diff --git a/Arduino15/packages/SPRESENSE/hardware/spresense/1.0.0/libraries/GNSS/GNSS.cpp b/Arduino15/packages/SPRESENSE/hardware/spresense/1.0.0/libraries/GNSS/GNSS.cpp
@@ -467,7 +467,7 @@ int SpGnss::isUpdate(void)
 
 /**
  * @brief Wait for position information to be updated
- * @param [in] timeout timeout of waiting
+ * @param [in] timeout timeout of waiting [sec]
  * @return 1 enable, 0 disable
  *
  * If not specified timeout, wait forever.

diff --git a/Arduino15/packages/SPRESENSE/hardware/spresense/1.0.0/libraries/GNSS/GNSS.h b/Arduino15/packages/SPRESENSE/hardware/spresense/1.0.0/libraries/GNSS/GNSS.h
@@ -300,7 +300,7 @@ class SpGnss
     /**
      * @brief Wait for position information to be updated
      * @details Calling this function will block until GNSS positioning information is updated.
-     * @param [in] timeout timeout of waiting
+     * @param [in] timeout timeout of waiting [sec]
      * @return 1 enable, 0 disable
      *
      * Returns 1 if position information is updated.