From 4f8bdc4a6f54a67d925a5de828171d8390fecf4f Mon Sep 17 00:00:00 2001
From: Hugues Delorme <delorme.hugues@fougsys.fr>
Date: Mon, 2 Mar 2015 16:49:52 +0100
Subject: [PATCH] Minor doc improvements

---
 src/gmio_core/endian.h |  2 +-
 src/gmio_stl/stl_io.h  | 10 ++++++----
 2 files changed, 7 insertions(+), 5 deletions(-)

diff --git a/src/gmio_core/endian.h b/src/gmio_core/endian.h
index 6a81eff..8a5499b 100644
--- a/src/gmio_core/endian.h
+++ b/src/gmio_core/endian.h
@@ -5,7 +5,7 @@
 
 GMIO_C_LINKAGE_BEGIN
 
-/*! This enum identifies endian representations of numbers */
+/*! This enum identifies common endianness (byte order) of computer memory */
 enum gmio_endianness
 {
   GMIO_LITTLE_ENDIAN,
diff --git a/src/gmio_stl/stl_io.h b/src/gmio_stl/stl_io.h
index c7d7621..63ffd41 100644
--- a/src/gmio_stl/stl_io.h
+++ b/src/gmio_stl/stl_io.h
@@ -16,12 +16,13 @@ GMIO_C_LINKAGE_BEGIN
 
 /*! \brief Options for gmio_stla_read()
  *
- *  No options yet, it just exists for future needs
+ *  No options yet, it just exists for future needs, which could possibly be:
+ *     - flag to force locale ?
+ *     - case sensitive/insensitive ?
  */
 struct gmio_stla_read_options
 {
   void* dummy; /*!< Structs must have at least one member in strict ISO-C90 */
-  /* Flag to force locale ? */
 };
 typedef struct gmio_stla_read_options  gmio_stla_read_options_t;
 
@@ -32,7 +33,7 @@ typedef struct gmio_stla_read_options  gmio_stla_read_options_t;
 GMIO_LIBSTL_EXPORT
 int gmio_stla_read(gmio_stl_mesh_creator_t* creator,
                    gmio_transfer_t* trsf,
-                   const gmio_stla_read_options_t* options); /* NULL */
+                   const gmio_stla_read_options_t* options /* NULL */);
 
 /*! \brief Options for gmio_stla_write()
  */
@@ -51,7 +52,8 @@ typedef struct gmio_stla_write_options  gmio_stla_write_options_t;
  *  \param mesh Defines the mesh to write
  *  \param trsf Defines needed objects (stream, buffer, ...) for the writing
  *              operation
- *  \param options Options for the writing operation
+ *  \param options Options for the writing operation, can be set to NULL to
+ *                 use default values
  *
  *  \return Error code
  *  \retval GMIO_NO_ERROR If operation successful