summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorGrigori Goronzy <greg@blackbox>2010-02-02 03:47:06 +0100
committerGrigori Goronzy <greg@blackbox>2010-02-02 03:47:06 +0100
commit5a0097d767e6da919a97b2f5c63550967547311a (patch)
treedf2c088860e03050a864ce3cda9fb8cc0bebfa06
parent81b39e85c73332a8d024a2281468af23f1f1f35b (diff)
downloadlibass-5a0097d767e6da919a97b2f5c63550967547311a.tar.bz2
libass-5a0097d767e6da919a97b2f5c63550967547311a.tar.xz
Clarify that libass expects subtitle packets in Matroska format
-rw-r--r--libass/ass.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/libass/ass.h b/libass/ass.h
index 822e3f7..c3a91e0 100644
--- a/libass/ass.h
+++ b/libass/ass.h
@@ -299,7 +299,8 @@ void ass_free_event(ASS_Track *track, int eid);
void ass_process_data(ASS_Track *track, char *data, int size);
/**
- * \brief Parse Codec Private section of subtitle stream.
+ * \brief Parse Codec Private section of the subtitle stream, in Matroska
+ * format. See the Matroska specification for details.
* \param track target track
* \param data string to parse
* \param size length of data
@@ -307,8 +308,8 @@ void ass_process_data(ASS_Track *track, char *data, int size);
void ass_process_codec_private(ASS_Track *track, char *data, int size);
/**
- * \brief Parse a chunk of subtitle stream data. In Matroska,
- * this contains exactly 1 event (or a commentary).
+ * \brief Parse a chunk of subtitle stream data. A chunk contains exactly one
+ * event in Matroska format. See the Matroska specification for details.
* \param track track
* \param data string to parse
* \param size length of data