iio.h: Fix documentation of iio_create_default_context()

The behaviour of the function changed about one year ago in commit 2e400fa ("getenv : keep Windows happy by using _dupenv_s rather than getenv") without anybody noticing; so fix the documentation so that it describes better the current behaviour. Signed-off-by: Paul Cercueil <[email protected]>
analogdevicesinc · May 28, 2021 · e3b3c3f · e3b3c3f
1 parent 4186af2
commit e3b3c3f
Showing 1 changed file with 3 additions and 5 deletions.
diff --git a/iio.h b/iio.h
@@ -349,11 +349,9 @@ __api __check_ret __cnst const char * iio_get_backend(unsigned int index);
  * @return On success, A pointer to an iio_context structure
  * @return On failure, NULL is returned and errno is set appropriately
  *
- * <b>NOTE:</b> This function will create a network context if the IIOD_REMOTE
- * environment variable is set to the hostname where the IIOD server runs. If
- * set to an empty string, the server will be discovered using ZeroConf.
- * If the environment variable is not set, a local context will be created
- * instead. */
+ * <b>NOTE:</b> This function will create a context with the URI
+ * provided in the IIOD_REMOTE environment variable. If not set, a local
+ * context will be created instead. */
 __api __check_ret struct iio_context * iio_create_default_context(void);