From d0ca150a384b0f5e0f23b61e78b91b0fe3394bb4 Mon Sep 17 00:00:00 2001
From: Laurent Deru <laurent.deru@cetic.be>
Date: Fri, 22 Dec 2017 11:22:38 +0100
Subject: [PATCH] Document new native platform defines

---
 arch/platform/native/platform.c | 20 ++++++++++++++++++++
 1 file changed, 20 insertions(+)

diff --git a/arch/platform/native/platform.c b/arch/platform/native/platform.c
index e12641414..4d1a1421c 100644
--- a/arch/platform/native/platform.c
+++ b/arch/platform/native/platform.c
@@ -70,23 +70,43 @@
 #define LOG_MODULE "Native"
 #define LOG_LEVEL LOG_LEVEL_MAIN
 
+/*---------------------------------------------------------------------------*/
+/**
+ * \name Native Platform Configuration
+ *
+ * @{
+ */
+
+/*
+ * Defines the maximum number of file descriptors monitored by the platform
+ * main loop.
+ */
 #ifdef SELECT_CONF_MAX
 #define SELECT_MAX SELECT_CONF_MAX
 #else
 #define SELECT_MAX 8
 #endif
 
+/*
+ * Defines the timeout (in msec) of the select operation if no monitored file
+ * descriptors becomes ready.
+ */
 #ifdef SELECT_CONF_TIMEOUT
 #define SELECT_TIMEOUT SELECT_CONF_TIMEOUT
 #else
 #define SELECT_TIMEOUT 1000
 #endif
 
+/*
+ * Adds the STDIN file descriptor to the list of monitored file descriptors.
+ */
 #ifdef SELECT_CONF_STDIN
 #define SELECT_STDIN SELECT_CONF_STDIN
 #else
 #define SELECT_STDIN 1
 #endif
+/** @} */
+/*---------------------------------------------------------------------------*/
 
 static const struct select_callback *select_callback[SELECT_MAX];
 static int select_max = 0;