struct opj_j2k: remove unused fields, and add some documentation

[openjpeg.git] / doc / openjpip.dox.in

diff --git a/doc/openjpip.dox.in b/doc/openjpip.dox.in
index 76bc5d2a8f29995419a2dba0ee72131aaae66953..fd06ee0e010a828304824aa2e0a203640512ac25 100644 (file)
--- a/doc/openjpip.dox.in
+++ b/doc/openjpip.dox.in
@@ -1,8 +1,8 @@
 /*
- * $Id: mainpage.h 47 2011-02-17 16:57:49Z 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,22 +28,21 @@
  * POSSIBILITY OF SUCH DAMAGE.
  */
 
-/*! \page openjpippage OpenJPIP v2.1 Documentation
+/*! \page openjpippage OpenJPIP v@OPENJPEG_VERSION@ Documentation
  *
- * \section intro Introduction
+ * \section Introduction
  * This manual documents the low-level OpenJPIP C API.\n
  * OpenJPIP software is an implementation of JPEG 2000 Part9: Interactivity tools, APIs and protocols (JPIP).\n
  * ( For more info about JPIP, check the website: http://www.jpeg.org/jpeg2000/j2kpart9.html)\n
  *
  * This whole documents covers the following six programs.\n
- * - opj_server.c     JPIP server supporting HTTP connection and JPT/JPP-stream
- * - opj_dec_server.c Server to decode JPT/JPP-stream and communicate locally with JPIP client, which is coded in java
- * - addXMLinJP2.c    To Embed metadata into JP2 file
- * - jpip_to_jp2.c    To Convert JPT/JPP-stream to JP2
- * - jpip_to_j2k.c    To Convert JPT/JPP-stream to J2K
- * - test_index.c     To test index code format of a JP2 file
- *
- * \section license License
+ * - opj_server.c          JPIP server supporting HTTP connection and JPT/JPP-stream
+ * - opj_dec_server.c      Server to decode JPT/JPP-stream and communicate locally with JPIP client, which is coded in java
+ * - opj_jpip_addxml.c     To Embed metadata into JP2 file
+ * - opj_jpip_transcode.c  To Convert JPT/JPP-stream to JP2 or J2K
+ * - opj_jpip_test.c       To test index code format of a JP2 file
+ *
+ * \section License
  * This software is released under the BSD license, anybody can use or modify the library, even for commercial applications.\n
  * The only restriction is to retain the copyright in the sources or the binaries documentation.\n
  * Neither the author, nor the university accept any responsibility for any kind of error or data loss which may occur during usage.
@@ -65,7 +64,7 @@
  *
  * 
  * \section sysarchtect System Architecture
- * JPIP protocol is implimented between the JPIP server program (opj_server) and the JPIP client java program (opj_viewer).\n
+ * JPIP protocol is implemented between the JPIP server program (opj_server) and the JPIP client java program (opj_viewer).\n
  * Figure below represents the overview of our system architecture.\n
  * The JPIP server parses JPIP query and sends corresponding JPT/JPP-stream.
  * The JPIP client viewer is an image viewer with GUI to publish JPIP requests and receive JPT/JPP-stream.\n
@@ -89,7 +88,7 @@
  * Before connecting to the JPIP server, every JPIP client checks local cache data of the requesting image with the image decoding server.
  * If its cache exists, the image decoding server provides ChannelID (CID), which identifies the image and its cache model on the JPIP server, and the whole system can continue the session using the CID.
  *
- *  \image html jpip_protocol.png "Message Sequence Chart of OpenJPIP impementation"
+ *  \image html jpip_protocol.png "Message Sequence Chart of OpenJPIP implementation"
  *
  * \author Kaori Hagihara UCL/SST/ICTM/ELEN
  */