ECC-200: doxygen documentation

fortran/eccodes_f90_head.f90

@@ -7,9 +7,8 @@
 ! virtue of its status as an intergovernmental organisation nor does it submit to any jurisdiction.
 !
 !
-!> Module eccodes
+!> Module eccodes\n
-!>
+!> This is the \b Fortran90 interface for ecCodes
-!> The eccodes module provides the Fortran 90 interface.
 module eccodes
 
   use grib_api
@@ -27,7 +26,7 @@ module eccodes
 
   !> Create a new message in memory from an integer or character array containting the coded message.
   !>
-  !> The message can be accessed through its gribid and it will be available\n
+  !> The message can be accessed through its ID and it will be available\n
   !> until @ref codes_release is called. A reference to the original coded\n
   !> message is kept in the new message structure.
   !>
@@ -38,7 +37,7 @@ module eccodes
   !>
   !> \b Examples: \ref copy_message.f90 "copy_message.f90"
   !>
-  !> @param gribid      id of the grib loaded in memory
+  !> @param id          ID of the message loaded in memory
   !> @param message     array containing the coded message
   !> @param status      CODES_SUCCESS if OK, integer value on error
   interface codes_new_from_message
@@ -48,12 +47,12 @@ module eccodes
 
   !> Get a value of specified index from an array key.
   !>
-  !> Given a gribid and key name as input a value corresponding to the given index
+  !> Given an ID and key name as input a value corresponding to the given index
   !> is returned. The index is zero based i.e. the first element has
   !> zero index, the second element index one and so on.
   !> If the parameter index is an array all the values correspondig to the indexes
   !> list is returned.
-  !> The gribid references to a grib message loaded in memory.
+  !> The ID references to a message loaded in memory.
   !>
   !> In case of error, if the status parameter (optional) is not given, the program will
   !> exit with an error message.\n Otherwise the error message can be
@@ -63,7 +62,7 @@ module eccodes
   !>
   !> @see codes_new_from_file, codes_release, codes_get
   !>
-  !> @param[in] gribid      id of the grib loaded in memory
+  !> @param[in] id          ID of the message loaded in memory
   !> @param[in] key         key name
   !> @param[in] index       index can be a scalar or array of integer(4)
   !> @param[out] value      value can be a scalar or array of integer(4),real(4),real(8)

fortran/grib_f90_tail.f90

@@ -350,7 +350,7 @@
       endif
   end subroutine grib_index_select_long
 
-   !> Select the message subset with key==value. The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.
+  !> Select the message subset with key==value. The value is a real. The key must have been created with real type or have real as native type if the type was not explicitly defined in the index creation.
   !>
   !>
   !> In case of error, if the status parameter (optional) is not given, the program will

src/eccodes.h

@@ -125,35 +125,48 @@ typedef struct grib_key_value_list    codes_key_value_list;
 
 /*! Codes handle,   structure giving access to parsed values by keys
     \ingroup codes_handle
+    \struct codes_handle
 */
+struct codes_handle;
 typedef struct grib_handle            codes_handle;
 
 /*! GRIB multi field handle,   structure used to build multi fields messages.
     \ingroup codes_handle
+    \struct codes_multi_handle
  */
+struct codes_multi_handle;
 typedef struct grib_multi_handle      codes_multi_handle;
 
 /*! Codes context,  structure containing the memory methods, the parsers and the formats.
     \ingroup codes_context
+    \struct codes_context
 */
+struct codes_context;
 typedef struct grib_context           codes_context;
 
 /*! Codes iterator, structure supporting a geographic iteration of values in a GRIB message.
-    \ingroup codes_iterator
+    \ingroup iterators
+    \struct codes_iterator
 */
+struct codes_iterator;
 typedef struct grib_iterator          codes_iterator;
 
 /*! Codes nearest, structure used to find the nearest points of a latitude longitude point in a GRIB message.
-    \ingroup codes_iterator
+    \ingroup iterators
+    \struct codes_nearest
 */
+struct codes_nearest;
 typedef struct grib_nearest           codes_nearest;
 typedef struct grib_box               codes_box;
 typedef struct grib_points            codes_points;
 
 /*! Codes keys iterator. Iterator over keys.
     \ingroup keys_iterator
+    \struct codes_keys_iterator
 */
+struct codes_keys_iterator;
 typedef struct grib_keys_iterator     codes_keys_iterator;
+
 typedef struct grib_fieldset          codes_fieldset;
 typedef struct grib_order_by          codes_order_by;
 typedef struct grib_where             codes_where;
@@ -177,13 +190,16 @@ codes_handle* codes_fieldset_next_handle(codes_fieldset* set,int* err);
 int  codes_fieldset_count(codes_fieldset *set);
 int  codes_values_check(codes_handle* h, codes_values* values, int count);
 
-/*! \defgroup codes_index The codes_index
+/*! \defgroup codes_index The indexing feature
 The codes_index is the structure giving indexed access to messages in a file.
  */
 /*! @{*/
 
 /*! index structure to access messages in a file.
+ * \ingroup codes_index
+ * \struct codes_index
 */
+struct codes_index;
 typedef struct grib_index             codes_index;
 
 /**
@@ -325,7 +341,7 @@ void codes_index_delete(codes_index* index);
 
 /*! @} */
 
-/*! \defgroup codes_handle The codes_handle
+/*! \defgroup codes_handle The message handle
 The codes_handle is the structure giving access to parsed message values by keys.
 */
 /*! @{*/