From 0a62cd1a18d61da725246ae1f236bd903b788958 Mon Sep 17 00:00:00 2001
From: Paul Bakker
Date: Fri, 21 Jan 2011 11:00:08 +0000
Subject: [PATCH] - Extra clarification in config header
---
include/polarssl/config.h | 37 ++++++++++++++++++++++++++++++++-----
1 file changed, 32 insertions(+), 5 deletions(-)
diff --git a/include/polarssl/config.h b/include/polarssl/config.h
index 80d0d306d..2372c35bd 100644
--- a/include/polarssl/config.h
+++ b/include/polarssl/config.h
@@ -35,6 +35,13 @@
#define _CRT_SECURE_NO_DEPRECATE 1
#endif
+/*
+ * \name SECTION: System support
+ *
+ * This section sets system specific settings.
+ * \{
+ */
+
/*
* Uncomment if native integers are 8-bit wide.
*
@@ -71,6 +78,15 @@
*
#define POLARSSL_HAVE_SSE2
*/
+/* \} name */
+
+/*
+ * \name SECTION: PolarSSL feature support
+ *
+ * This section sets support for features that are or are not needed
+ * within the modules that are enabled.
+ * \{
+ */
/*
* Enable all SSL/TLS debugging messages.
@@ -82,11 +98,6 @@
*/
#define POLARSSL_SELF_TEST
-/*
- * Enable run-time version information functions
- */
-#define POLARSSL_VERSION_C
-
/*
* Enable the prime-number generation code.
*/
@@ -97,6 +108,14 @@
*
#define POLARSSL_AES_ROM_TABLES
*/
+/* \} name */
+
+/*
+ * \name SECTION: PolarSSL modules
+ *
+ * This section enables or disables entire modules in PolarSSL
+ * \{
+ */
/*
* Module: library/aes.c
@@ -337,6 +356,13 @@
*/
#define POLARSSL_TIMING_C
+/*
+ * Module: library/version.c
+ *
+ * This module provides run-time version information.
+ */
+#define POLARSSL_VERSION_C
+
/*
* Module: library/x509parse.c
* Caller: library/ssl_cli.c
@@ -360,5 +386,6 @@
* Caller:
*/
#define POLARSSL_XTEA_C
+/* \} name */
#endif /* config.h */