From b93572dca8549b1010414597bb46ddfc1ba40cc3 Mon Sep 17 00:00:00 2001
From: goldsimon <goldsimon@gmx.de>
Date: Thu, 20 Apr 2017 22:00:07 +0200
Subject: [PATCH] Document struct netvector

---
 src/include/lwip/api.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/src/include/lwip/api.h b/src/include/lwip/api.h
index 60711080..901d025d 100644
--- a/src/include/lwip/api.h
+++ b/src/include/lwip/api.h
@@ -270,8 +270,15 @@ struct netconn {
   netconn_callback callback;
 };
 
+/** This vector type is passed to @ref netconn_write_vectors_partly to send
+ * multiple buffers at once.
+ * ATTENTION: This type has to directly map @ref struct iovec since one is casted
+ *            into the other!
+ */
 struct netvector {
+  /** pointer to the application buffer that contains the data to send */
   const void *ptr;
+  /** size of the application data to send */
   size_t len;
 };