From 504f6a0876fbd7e5ca3de2bae63c6e7e8178d424 Mon Sep 17 00:00:00 2001 From: Shahram Najm Date: Tue, 27 Sep 2016 13:57:55 +0100 Subject: [PATCH] Documentation update (doxygen/html) --- html/eccodes_8h.html | 5 +++- html/globals.html | 3 ++ html/globals_func.html | 3 ++ html/group__get__set.html | 55 +++++++++++++++++++++++++++++++++++++ html/search/all_63.js | 2 +- html/search/functions_63.js | 2 +- 6 files changed, 67 insertions(+), 3 deletions(-) diff --git a/html/eccodes_8h.html b/html/eccodes_8h.html index 894017fe2..c79fc8833 100644 --- a/html/eccodes_8h.html +++ b/html/eccodes_8h.html @@ -493,6 +493,9 @@ Functions int codes_set_long_array (codes_handle *h, const char *key, const long *vals, size_t length)  Set a long array from a key. More...
  +int codes_set_string_array (codes_handle *h, const char *key, const char **vals, size_t length) + Set a string array from a key. More...
+  void codes_dump_content (codes_handle *h, FILE *out, const char *mode, unsigned long option_flags, void *arg)  Print all keys, with the context print procedure and dump mode to a resource. More...
  @@ -644,7 +647,7 @@ Functions - +
h: the handle to be printed
out: output file handle
mode: available dump modes are: debug wmo c_code
mode: Examples of available dump modes: debug wmo
option_flags: all the CODES_DUMP_FLAG_x flags can be used
arg: used to provide a format to output data (experimental)
diff --git a/html/globals.html b/html/globals.html index c3d6a48ce..745a406e4 100644 --- a/html/globals.html +++ b/html/globals.html @@ -518,6 +518,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • codes_set_string() : eccodes.h
    • +
  • codes_set_string_array() +: eccodes.h +
  • CODES_STRING_TOO_SMALL : eccodes.h
    • diff --git a/html/globals_func.html b/html/globals_func.html index bf4d60728..f3b437338 100644 --- a/html/globals_func.html +++ b/html/globals_func.html @@ -341,6 +341,9 @@ var searchBox = new SearchBox("searchBox", "search",false,'Search');
  • codes_set_string() : eccodes.h
    • +
  • codes_set_string_array() +: eccodes.h +
  • codes_write_message() : eccodes.h
    • diff --git a/html/group__get__set.html b/html/group__get__set.html index e4f681313..1ead2fad3 100644 --- a/html/group__get__set.html +++ b/html/group__get__set.html @@ -140,6 +140,9 @@ Functions int codes_set_long_array (codes_handle *h, const char *key, const long *vals, size_t length)  Set a long array from a key. More...
      +int codes_set_string_array (codes_handle *h, const char *key, const char **vals, size_t length) + Set a string array from a key. More...
    + 

    Detailed Description

    Function Documentation

    @@ -1054,6 +1057,58 @@ Functions
    Returns
    0 if OK, integer value on error
    + + + +
    +
    + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    int codes_set_string_array (codes_handle * h,
    const char * key,
    const char ** vals,
    size_t length 
    )
    +
    + +

    Set a string array from a key.

    +

    If several keys of the same name are present, the last one is set

    +
    See Also
    codes_get_long_array
    +
    Parameters
    + + + + + +
    h: the handle to set the data to
    key: the key to be searched
    vals: the address of a string array where the data will be read
    length: a size_t that contains the length of the array on input
    +
    +
    +
    Returns
    0 if OK, integer value on error
    +
    diff --git a/html/search/all_63.js b/html/search/all_63.js index e3620d0a5..560d7354d 100644 --- a/html/search/all_63.js +++ b/html/search/all_63.js @@ -261,7 +261,7 @@ var searchData= ['codes_5fset_5freal8_5farray',['codes_set_real8_array',['../interfaceeccodes_1_1codes__set.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set::codes_set_real8_array()'],['../classeccodes.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set_real8_array()']]], ['codes_5fset_5fsamples_5fpath',['codes_set_samples_path',['../classeccodes.html#af4be467f3273e17111becbd483c25018',1,'eccodes::codes_set_samples_path()'],['../namespaceec_codes.html#ab7f299aaed48129491cc365a8ca289c2',1,'ecCodes.codes_set_samples_path()']]], ['codes_5fset_5fstring',['codes_set_string',['../interfaceeccodes_1_1codes__set.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set::codes_set_string()'],['../classeccodes.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set_string()'],['../group__get__set.html#ga6062cdd5950966bffa72e74708f85368',1,'codes_set_string(): eccodes.h'],['../namespaceec_codes.html#acbb0d241a917a3e726792157c1f5d973',1,'ecCodes.codes_set_string()']]], - ['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes']]], + ['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes::codes_set_string_array()'],['../group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5',1,'codes_set_string_array(): eccodes.h']]], ['codes_5fset_5fvalues',['codes_set_values',['../namespaceec_codes.html#abc699d0bb7a7dded968ee0111342ffd0',1,'ecCodes']]], ['codes_5fskip_5fcoded',['codes_skip_coded',['../classeccodes.html#a56a1567687b281d07c193ce273c0e1b2',1,'eccodes::codes_skip_coded()'],['../namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad',1,'ecCodes.codes_skip_coded()']]], ['codes_5fskip_5fcomputed',['codes_skip_computed',['../classeccodes.html#aad63202303a1b6aaf9f5e605622a8095',1,'eccodes::codes_skip_computed()'],['../namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779',1,'ecCodes.codes_skip_computed()']]], diff --git a/html/search/functions_63.js b/html/search/functions_63.js index 9ddfd5172..0858ee99e 100644 --- a/html/search/functions_63.js +++ b/html/search/functions_63.js @@ -182,7 +182,7 @@ var searchData= ['codes_5fset_5freal8_5farray',['codes_set_real8_array',['../interfaceeccodes_1_1codes__set.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set::codes_set_real8_array()'],['../classeccodes.html#a14b3bc17ea1ee83936f32dd0fced44a4',1,'eccodes::codes_set_real8_array()']]], ['codes_5fset_5fsamples_5fpath',['codes_set_samples_path',['../classeccodes.html#af4be467f3273e17111becbd483c25018',1,'eccodes::codes_set_samples_path()'],['../namespaceec_codes.html#ab7f299aaed48129491cc365a8ca289c2',1,'ecCodes.codes_set_samples_path()']]], ['codes_5fset_5fstring',['codes_set_string',['../interfaceeccodes_1_1codes__set.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set::codes_set_string()'],['../classeccodes.html#a50acfd20f8dff8b4e547135057ef119a',1,'eccodes::codes_set_string()'],['../group__get__set.html#ga6062cdd5950966bffa72e74708f85368',1,'codes_set_string(): eccodes.h'],['../namespaceec_codes.html#acbb0d241a917a3e726792157c1f5d973',1,'ecCodes.codes_set_string()']]], - ['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes']]], + ['codes_5fset_5fstring_5farray',['codes_set_string_array',['../classeccodes.html#aae3ccb53638a4d16daf98d937a96e8b6',1,'eccodes::codes_set_string_array()'],['../group__get__set.html#ga6840ee00df4366a431bedcef609f8ae5',1,'codes_set_string_array(): eccodes.h']]], ['codes_5fset_5fvalues',['codes_set_values',['../namespaceec_codes.html#abc699d0bb7a7dded968ee0111342ffd0',1,'ecCodes']]], ['codes_5fskip_5fcoded',['codes_skip_coded',['../classeccodes.html#a56a1567687b281d07c193ce273c0e1b2',1,'eccodes::codes_skip_coded()'],['../namespaceec_codes.html#a4b7140ca0dd81372721cffd1d964e4ad',1,'ecCodes.codes_skip_coded()']]], ['codes_5fskip_5fcomputed',['codes_skip_computed',['../classeccodes.html#aad63202303a1b6aaf9f5e605622a8095',1,'eccodes::codes_skip_computed()'],['../namespaceec_codes.html#a587af29aac21a816f8ffd327a1fce779',1,'ecCodes.codes_skip_computed()']]],