encoder/ToOutputStream: add API docs

MusicPlayerDaemon · Sep 26, 2023 · 9a0b377 · 9a0b377
1 parent 2075a9a
commit 9a0b377
Showing 1 changed file with 7 additions and 4 deletions.
diff --git 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