openjpeg version 1.0 (previous version still available with tag opj0-97)

[openjpeg.git] / libopenjpeg / int.h

diff --git a/libopenjpeg/int.h b/libopenjpeg/int.h
index 52add1acf1a97028b34b447938ff9307f57674e1..d838e968fe809417e30266809689278a1caf68e5 100644 (file)
--- a/libopenjpeg/int.h
+++ b/libopenjpeg/int.h
@@ -1,5 +1,9 @@
 /*
- * Copyright (c) 2001-2002, David Janssens
+ * Copyright (c) 2001-2003, David Janssens
+ * Copyright (c) 2002-2003, Yannick Verschueren
+ * Copyright (c) 2003-2005, Francois Devaux and Antonin Descampe
+ * Copyright (c) 2005, Herv� Drolon, FreeImage Team
+ * Copyright (c) 2002-2005, Communications and remote sensing Laboratory, Universite catholique de Louvain, Belgium
  * All rights reserved.
  *
  * Redistribution and use in source and binary forms, with or without
@@ -24,65 +28,69 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-#include "j2k.h"
-
 #ifndef __INT_H
 #define __INT_H
+/**
+@file int.h
+@brief Implementation of operations on integers (INT)
 
-/*
- * Get the minimum of two integers.
- *
- * returns a if a < b else b
- */
-int int_min(int a, int b);
+The functions in INT.C have for goal to realize operations on integers.
+*/
 
-/*
- * Get the maximum of two integers.
- *
- * returns a if a > b else b
- */
-int int_max(int a, int b);
+/** @defgroup INT INT - Implementation of operations on integers */
+/*@{*/
 
-/*
- * Clamp an integer inside an interval.
- *
- * return a if (min < a < max)
- * return max if (a > max)
- * return min if (a < min) 
- */
+/** @name Exported functions (see also openjpeg.h) */
+/*@{*/
+/* ----------------------------------------------------------------------- */
+/**
+Get the minimum of two integers
+@return Returns a if a < b else b
+*/
+int int_min(int a, int b);
+/**
+Get the maximum of two integers
+@return Returns a if a > b else b
+*/
+int int_max(int a, int b);
+/**
+Clamp an integer inside an interval
+@return
+<ul>
+<li>Returns a if (min < a < max)
+<li>Returns max if (a > max)
+<li>Returns min if (a < min) 
+</ul>
+*/
 int int_clamp(int a, int min, int max);
-
-/*
- * Get absolute value of integer.
- */
+/**
+@return Get absolute value of integer
+*/
 int int_abs(int a);
-
-/*
- * Divide an integer and round upwards.
- *
- * a divided by b
- */
+/**
+Divide an integer and round upwards
+@return Returns a divided by b
+*/
 int int_ceildiv(int a, int b);
+/**
+Divide an integer by a power of 2 and round upwards
+@return Returns a divided by 2^b
+*/
+int int_ceildivpow2(int a, int b);
+/**
+Divide an integer by a power of 2 and round downwards
+@return Returns a divided by 2^b
+*/
+int int_floordivpow2(int a, int b);
+/**
+Get logarithm of an integer and round downwards
+@return Returns log2(a)
+*/
+int int_floorlog2(int a);
 
-/*
- * Divide an integer by a power of 2 and round upwards.
- *
- * a divided by 2^b
- */
-LIBJ2K_API int int_ceildivpow2(int a, int b);
-
-/*
- * Divide an integer by a power of 2 and round downwards.
- *
- * a divided by 2^b
- */
-LIBJ2K_API int int_floordivpow2(int a, int b);
+/* ----------------------------------------------------------------------- */
+/*@}*/
 
-/*
- * Get logarithm of an integer and round downwards.
- *
- * log2(a)
- */
-int int_floorlog2(int a);
+/*@}*/
 
 #endif