From 86d0534638b6854af663b77d7e082ea8c1af76bf Mon Sep 17 00:00:00 2001
From: Max Kellermann <max@musicpd.org>
Date: Fri, 2 Aug 2019 13:56:00 +0200
Subject: [PATCH] lib/xiph/OggVisitor: more API documentation

---
 src/lib/xiph/OggVisitor.hxx | 13 +++++++++++++
 1 file changed, 13 insertions(+)

diff --git a/src/lib/xiph/OggVisitor.hxx b/src/lib/xiph/OggVisitor.hxx
index a7e6eb9b8..e20548dd2 100644
--- a/src/lib/xiph/OggVisitor.hxx
+++ b/src/lib/xiph/OggVisitor.hxx
@@ -69,8 +69,21 @@ private:
 	void HandlePackets();
 
 protected:
+	/**
+	 * Called when the "beginning of stream" packet has been seen.
+	 *
+	 * @param packet the "beginning of stream" packet
+	 */
 	virtual void OnOggBeginning(const ogg_packet &packet) = 0;
+
+	/**
+	 * Called for each follow-up packet.
+	 */
 	virtual void OnOggPacket(const ogg_packet &packet) = 0;
+
+	/**
+	 * Called after the "end of stream" packet has been processed.
+	 */
 	virtual void OnOggEnd() = 0;
 };