diff options
author | Ralph Giles <giles@thaumas.net> | 2019-08-13 08:55:32 -0700 |
---|---|---|
committer | Ralph Giles <giles@thaumas.net> | 2019-08-13 08:55:32 -0700 |
commit | 51b74c367b7aed79b5561e9d13c2cb4b3a57762b (patch) | |
tree | 79a04f7999b12310077299b3ca9da63ce016062e /doc | |
parent | 3461004ef053d50ce57260ed8ccbd9744ef9a329 (diff) | |
download | ogg-git-51b74c367b7aed79b5561e9d13c2cb4b3a57762b.tar.gz |
Improve ogg_stream_state documentation formatting.
Copy the struct definition from ogg.h which has better comment
alignment.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/libogg/ogg_stream_state.html | 17 |
1 files changed, 9 insertions, 8 deletions
diff --git a/doc/libogg/ogg_stream_state.html b/doc/libogg/ogg_stream_state.html index ece2c0e..0f06fa1 100644 --- a/doc/libogg/ogg_stream_state.html +++ b/doc/libogg/ogg_stream_state.html @@ -18,7 +18,8 @@ <p><i>declared in "ogg/ogg.h"</i></p> <p> -The ogg_stream_state struct tracks the current encode/decode state of the current logical bitstream. +The ogg_stream_state struct tracks the current encode/decode state +of the current logical bitstream. <p> <table border=0 width=100% color=black cellspacing=0 cellpadding=7> @@ -32,10 +33,10 @@ typedef struct { long body_returned; /* elements of fill returned */ - int *lacing_vals; /* The values that will go to the segment table */ - ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact - this way, but it is simple coupled to the - lacing fifo */ + int *lacing_vals; /* The values that will go to the segment table */ + ogg_int64_t *granule_vals; /* granulepos values for headers. Not compact + this way, but it is simple coupled to the + lacing fifo */ long lacing_storage; long lacing_fill; long lacing_packet; @@ -48,9 +49,9 @@ typedef struct { logical bitstream */ int b_o_s; /* set after we've written the initial page of a logical bitstream */ - long serialno; - long pageno; - ogg_int64_t packetno; /* sequence number for decode; the framing + long serialno; + long pageno; + ogg_int64_t packetno; /* sequence number for decode; the framing knows where there's a hole in the data, but we need coupling so that the codec (which is in a separate abstraction |