From 9a0b3775d8f807696b2361329cbde4f67113a078 Mon Sep 17 00:00:00 2001
From: Max Kellermann <max.kellermann@gmail.com>
Date: Tue, 26 Sep 2023 15:48:26 +0200
Subject: [PATCH] encoder/ToOutputStream: add API docs

---
 src/encoder/ToOutputStream.hxx | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/src/encoder/ToOutputStream.hxx b/src/encoder/ToOutputStream.hxx
index 7f51eee02..503b6170f 100644
--- a/src/encoder/ToOutputStream.hxx
+++ b/src/encoder/ToOutputStream.hxx
@@ -1,13 +1,16 @@
 // SPDX-License-Identifier: GPL-2.0-or-later
 // Copyright The Music Player Daemon Project
 
-#ifndef MPD_ENCODER_TO_OUTPUT_STREAM_HXX
-#define MPD_ENCODER_TO_OUTPUT_STREAM_HXX
+#pragma once
 
 class OutputStream;
 class Encoder;
 
+/**
+ * Read all available output from the #Encoder and write it to the
+ * #OutputStream.
+ *
+ * Throws on error.
+ */
 void
 EncoderToOutputStream(OutputStream &os, Encoder &encoder);
-
-#endif