Update Doxygen doc
[openjpeg.git] / doxygen / structopj__tcd__seg.html
index 55cf2c8489baeb4cedeba1f0c3a99759939fa58f..589ddbf338e7efc818c5b47662c2af626f3dc700 100644 (file)
@@ -18,7 +18,7 @@
  <tr style="height: 56px;">
   <td id="projectalign" style="padding-left: 0.5em;">
    <div id="projectname">OpenJPEG
-   &#160;<span id="projectnumber">2.1.2</span>
+   &#160;<span id="projectnumber">2.2.0</span>
    </div>
   </td>
  </tr>
 </div><!--header-->
 <div class="contents">
 
-<p>FIXME DOC.  
+<p>Segment of a code-block.  
  <a href="structopj__tcd__seg.html#details">More...</a></p>
 
 <p><code>#include &lt;<a class="el" href="tcd_8h_source.html">tcd.h</a>&gt;</code></p>
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
 Data Fields</h2></td></tr>
-<tr class="memitem:a5fc2a3d551529795b4eff8df23728f7d"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a> **&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#a5fc2a3d551529795b4eff8df23728f7d">data</a></td></tr>
-<tr class="separator:a5fc2a3d551529795b4eff8df23728f7d"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ab628ecf0163e8e630b863076590d577b"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#ab628ecf0163e8e630b863076590d577b">dataindex</a></td></tr>
-<tr class="separator:ab628ecf0163e8e630b863076590d577b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae2849ad158d18620e92927c34758ae97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#ae2849ad158d18620e92927c34758ae97">len</a></td></tr>
+<tr class="separator:ae2849ad158d18620e92927c34758ae97"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:af08dca9f35fa85c26e4d5d100465da58"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#af08dca9f35fa85c26e4d5d100465da58">numpasses</a></td></tr>
 <tr class="separator:af08dca9f35fa85c26e4d5d100465da58"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a0015ec198dfb26b7bed3b6c56c165cd0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#a0015ec198dfb26b7bed3b6c56c165cd0">real_num_passes</a></td></tr>
 <tr class="separator:a0015ec198dfb26b7bed3b6c56c165cd0"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ae2849ad158d18620e92927c34758ae97"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#ae2849ad158d18620e92927c34758ae97">len</a></td></tr>
-<tr class="separator:ae2849ad158d18620e92927c34758ae97"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a23beaa4f525a2a562317afbf77b804db"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#a23beaa4f525a2a562317afbf77b804db">maxpasses</a></td></tr>
 <tr class="separator:a23beaa4f525a2a562317afbf77b804db"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:aa911a7f48e381acf250901ba679b12da"><td class="memItemLeft" align="right" valign="top"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structopj__tcd__seg.html#aa911a7f48e381acf250901ba679b12da">numnewpasses</a></td></tr>
@@ -76,36 +72,9 @@ Data Fields</h2></td></tr>
 <tr class="separator:ae9c1afe0f4e4717998228b951caa465d"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table>
 <a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
-<div class="textblock"><p>FIXME DOC. </p>
+<div class="textblock"><p>Segment of a code-block. </p>
+<p>A segment represent a number of consecutive coding passes, without termination of MQC or RAW between them. </p>
 </div><h2 class="groupheader">Field Documentation</h2>
-<a class="anchor" id="a5fc2a3d551529795b4eff8df23728f7d"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a22de44e15bddae7edfacf4e9ac9bb199">OPJ_BYTE</a>** opj_tcd_seg::data</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Referenced by <a class="el" href="group___t1.html#gac0eda7cad23045baec567ddbe0a4da3f">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
-
-</div>
-</div>
-<a class="anchor" id="ab628ecf0163e8e630b863076590d577b"></a>
-<div class="memitem">
-<div class="memproto">
-      <table class="memname">
-        <tr>
-          <td class="memname"><a class="el" href="openjpeg_8h.html#a4cb1e6e6b6ef2df499d5c02f7df54cbb">OPJ_UINT32</a> opj_tcd_seg::dataindex</td>
-        </tr>
-      </table>
-</div><div class="memdoc">
-
-<p>Referenced by <a class="el" href="group___t1.html#gac0eda7cad23045baec567ddbe0a4da3f">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
-
-</div>
-</div>
 <a class="anchor" id="ae2849ad158d18620e92927c34758ae97"></a>
 <div class="memitem">
 <div class="memproto">
@@ -116,7 +85,7 @@ Data Fields</h2></td></tr>
       </table>
 </div><div class="memdoc">
 
-<p>Referenced by <a class="el" href="group___t1.html#gac0eda7cad23045baec567ddbe0a4da3f">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
+<p>Referenced by <a class="el" href="group___t1.html#gab90391839b2f56ca40aaae1b8748ca3c">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
 
 </div>
 </div>
@@ -186,7 +155,7 @@ Data Fields</h2></td></tr>
       </table>
 </div><div class="memdoc">
 
-<p>Referenced by <a class="el" href="group___t1.html#gac0eda7cad23045baec567ddbe0a4da3f">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
+<p>Referenced by <a class="el" href="group___t1.html#gab90391839b2f56ca40aaae1b8748ca3c">opj_t1_decode_cblk()</a>, and <a class="el" href="group___t2.html#ga1ad0998fa29444d7f3a4ad4f5685a045">opj_t2_read_packet_data()</a>.</p>
 
 </div>
 </div>