From 43e06aaa8ba478cf995ba8c6aebbb6365b68cb68 Mon Sep 17 00:00:00 2001
From: Josh Coalson <jcoalson@users.sourceforce.net>
Date: Thu, 8 Aug 2002 22:50:31 +0000
Subject: [PATCH] minor comments

---
 include/OggFLAC/stream_encoder.h | 7 +++++++
 1 file changed, 7 insertions(+)

diff --git a/include/OggFLAC/stream_encoder.h b/include/OggFLAC/stream_encoder.h
index 483b3f25..f1b97c58 100644
--- a/include/OggFLAC/stream_encoder.h
+++ b/include/OggFLAC/stream_encoder.h
@@ -374,6 +374,13 @@ FLAC__bool OggFLAC__stream_encoder_set_total_samples_estimate(OggFLAC__StreamEnc
 FLAC__bool OggFLAC__stream_encoder_set_metadata(OggFLAC__StreamEncoder *encoder, FLAC__StreamMetadata **metadata, unsigned num_blocks);
 
 /** Set the write callback.
+ *
+ * \note
+ * Unlike the FLAC stream encoder write callback, the Ogg stream
+ * encoder write callback will be called twice when writing audio
+ * frames; once for the page header, and once for the page body.
+ * When writing the page header, the \a samples argument to the
+ * write callback will be \c 0.
  *
  * \note
  * The callback is mandatory and must be set before initialization.