Fix some typos (found by codespell)

[openjpeg.git] / src / lib / openjpip / metadata_manager.h

diff --git a/src/lib/openjpip/metadata_manager.h b/src/lib/openjpip/metadata_manager.h
index 089b19a5cd123d440cb322516f3773bc35454daa..1a38973652365f8ed201fa4fac508962d619f463 100644 (file)
--- a/src/lib/openjpip/metadata_manager.h
+++ b/src/lib/openjpip/metadata_manager.h
@@ -1,8 +1,8 @@
 /*
- * $Id: metadata_manager.h 44 2011-02-15 12:32:29Z kaori $
+ * $Id$
  *
- * Copyright (c) 2002-2011, Communications and Remote Sensing Laboratory, Universite catholique de Louvain (UCL), Belgium
- * Copyright (c) 2002-2011, Professor Benoit Macq
+ * Copyright (c) 2002-2014, Universite catholique de Louvain (UCL), Belgium
+ * Copyright (c) 2002-2014, Professor Benoit Macq
  * Copyright (c) 2010-2011, Kaori Hagihara
  * All rights reserved.
  *
@@ -28,30 +28,32 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#ifndef        METADATA_MANAGER_H_
-#define        METADATA_MANAGER_H_
+#ifndef     METADATA_MANAGER_H_
+#define     METADATA_MANAGER_H_
 
 #include "box_manager.h"
 #include "placeholder_manager.h"
 
-typedef struct boxcontents_param{
-  OPJ_OFF_T offset; /**< byte position of the box contents in the file*/
-  Byte8_t length; /**< length of the box contents*/
+typedef struct boxcontents_param {
+    OPJ_OFF_T offset; /**< byte position of the box contents in the file*/
+    Byte8_t length; /**< length of the box contents*/
 } boxcontents_param_t;
 
 /** metadata-bin parameters*/
-typedef struct metadata_param{
-  Byte8_t idx;                                  /**< index number*/
-  boxlist_param_t *boxlist;                 /**< box list*/
-  placeholderlist_param_t *placeholderlist; /**< placeholder box list*/
-  boxcontents_param_t *boxcontents;         /**< box contens in case of no boxlist and placeholderlist*/
-  struct metadata_param *next;              /**< pointer to the next metadata-bin*/
+typedef struct metadata_param {
+    Byte8_t idx;                                  /**< index number*/
+    boxlist_param_t *boxlist;                 /**< box list*/
+    placeholderlist_param_t *placeholderlist; /**< placeholder box list*/
+    boxcontents_param_t
+    *boxcontents;         /**< box contents in case of no boxlist and placeholderlist*/
+    struct metadata_param
+        *next;              /**< pointer to the next metadata-bin*/
 } metadata_param_t;
 
 /** metadata-bin list parameters*/
-typedef struct metadatalist_param{
-  metadata_param_t *first; /**< first metadata-bin pointer of the list*/
-  metadata_param_t *last;  /**< last metadata-bin pointer of the list*/
+typedef struct metadatalist_param {
+    metadata_param_t *first; /**< first metadata-bin pointer of the list*/
+    metadata_param_t *last;  /**< last metadata-bin pointer of the list*/
 } metadatalist_param_t;
 
 
@@ -69,7 +71,7 @@ metadatalist_param_t * gene_metadatalist(void);
  * @param[in] fd file descriptor
  * @return            pointer to the generated metadata-bin list
  */
-metadatalist_param_t * const_metadatalist( int fd);
+metadatalist_param_t * const_metadatalist(int fd);
 
 
 /**
@@ -77,7 +79,7 @@ metadatalist_param_t * const_metadatalist( int fd);
  *
  * @param[in,out] list address of the metadata list pointer
  */
-void delete_metadatalist( metadatalist_param_t **list);
+void delete_metadatalist(metadatalist_param_t **list);
 
 
 /**
@@ -89,35 +91,36 @@ void delete_metadatalist( metadatalist_param_t **list);
  * @param[in] boxcontents boxcontents pointer
  * @return                pointer to the generated metadata bin
  */
-metadata_param_t * gene_metadata( Byte8_t idx, boxlist_param_t *boxlist, placeholderlist_param_t *phldlist, boxcontents_param_t *boxcontents);
+metadata_param_t * gene_metadata(Byte8_t idx, boxlist_param_t *boxlist,
+                                 placeholderlist_param_t *phldlist, boxcontents_param_t *boxcontents);
 
 /**
  * delete a metadata bin
  *
  * @param[in,out] metadata address of the deleting metadata bin pointer
  */
-void delete_metadata( metadata_param_t **metadata);
+void delete_metadata(metadata_param_t **metadata);
 
 /**
  * generate box contents
  *
  * @return pointer to the box contents
  */
-boxcontents_param_t * gene_boxcontents( OPJ_OFF_T offset, OPJ_SIZE_T length);
+boxcontents_param_t * gene_boxcontents(OPJ_OFF_T offset, OPJ_SIZE_T length);
 
 /**
  * print metadata-bin parameters
  *
  * @param[in] metadata metadata-bin pointer
  */
-void print_metadata( metadata_param_t *metadata);
+void print_metadata(metadata_param_t *metadata);
 
 /**
  * print all metadata parameters
  *
- * @param[in] metadatalist metadata list pointer
+ * @param[in] list metadata list pointer
  */
-void print_allmetadata( metadatalist_param_t *list);
+void print_allmetadata(metadatalist_param_t *list);
 
 
 /**
@@ -127,7 +130,7 @@ void print_allmetadata( metadatalist_param_t *list);
  * @param[in] list metadata-bin list pointer
  * @return         found metadata-bin pointer
  */
-metadata_param_t * search_metadata( Byte8_t idx, metadatalist_param_t *list);
+metadata_param_t * search_metadata(Byte8_t idx, metadatalist_param_t *list);
 
 
 /**
@@ -137,7 +140,7 @@ metadata_param_t * search_metadata( Byte8_t idx, metadatalist_param_t *list);
  * @param[in] list    metadata-bin list pointer
  * @return            found metadata-bin index, if not found, -1
  */
-Byte8_t search_metadataidx( char boxtype[4], metadatalist_param_t *list);
+Byte8_t search_metadataidx(char boxtype[4], metadatalist_param_t *list);
 
 
 /**
@@ -146,6 +149,7 @@ Byte8_t search_metadataidx( char boxtype[4], metadatalist_param_t *list);
  * @param[in] metabin      metadata-bin pointer
  * @param[in] metadatalist metadata list pointer
  */
-void insert_metadata_into_list( metadata_param_t *metabin, metadatalist_param_t *metadatalist);
+void insert_metadata_into_list(metadata_param_t *metabin,
+                               metadatalist_param_t *metadatalist);
 
-#endif             /* !METADATA_MANAGER_H_ */
+#endif      /* !METADATA_MANAGER_H_ */