net: lib: download_client: minor update to doc

lemrey · rlubos · commit fd0965cb19e3 · 2019-11-12T12:33:06.000+01:00
Hint that fragment size is an upper bound, but not a lower bound.

Signed-off-by: Emanuele Di Santo &lt;emdi@nordicsemi.no&gt;
diff --git a/include/net/download_client.h b/include/net/download_client.h
@@ -173,7 +173,7 @@ int download_client_connect(struct download_client *client, const char *host,
 /**
  * @brief Download a file.
  *
- * The download is carried out in fragments of @c
+ * The download is carried out in fragments of up to @c
  * CONFIG_DOWNLOAD_CLIENT_MAX_FRAGMENT_SIZE bytes,
  * which are delivered to the application
  * via @ref DOWNLOAD_CLIENT_EVT_FRAGMENT events.

Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ int download_client_connect(struct download_client client, const char host,`
`173`	`173`	`/**`
`174`	`174`	`* @brief Download a file.`
`175`	`175`	`*`
`176`		`- * The download is carried out in fragments of @c`
	`176`	`+ * The download is carried out in fragments of up to @c`
`177`	`177`	`* CONFIG_DOWNLOAD_CLIENT_MAX_FRAGMENT_SIZE bytes,`
`178`	`178`	`* which are delivered to the application`
`179`	`179`	`* via @ref DOWNLOAD_CLIENT_EVT_FRAGMENT events.`