aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMax Kellermann <max@duempel.org>2015-01-31 22:17:15 +0100
committerMax Kellermann <max@duempel.org>2015-01-31 22:17:15 +0100
commiteb1733609ad9a0842ba1c77b1c375507929f9585 (patch)
tree8029b3b81d8e8ffb9ef0871a3e46796c000deb70
parente2e66404d5fa8f3fcc0581abdf6d2ccc9790954e (diff)
downloadmpd-eb1733609ad9a0842ba1c77b1c375507929f9585.tar.gz
mpd-eb1733609ad9a0842ba1c77b1c375507929f9585.tar.xz
mpd-eb1733609ad9a0842ba1c77b1c375507929f9585.zip
decoder/sndfile, ...: update API documentation
-rw-r--r--src/decoder/DecoderPlugin.hxx2
-rw-r--r--src/decoder/DecoderThread.cxx4
-rw-r--r--src/decoder/plugins/DsdLib.cxx4
-rw-r--r--src/decoder/plugins/SndfileDecoderPlugin.cxx2
-rw-r--r--src/decoder/plugins/WavpackDecoderPlugin.cxx2
-rw-r--r--src/input/Init.hxx4
-rw-r--r--src/input/TextInputStream.hxx4
-rw-r--r--src/playlist/PlaylistRegistry.hxx2
-rw-r--r--src/playlist/PlaylistStream.hxx2
9 files changed, 13 insertions, 13 deletions
diff --git a/src/decoder/DecoderPlugin.hxx b/src/decoder/DecoderPlugin.hxx
index ef275266c..75cba6385 100644
--- a/src/decoder/DecoderPlugin.hxx
+++ b/src/decoder/DecoderPlugin.hxx
@@ -53,7 +53,7 @@ struct DecoderPlugin {
void (*finish)(void);
/**
- * Decode a stream (data read from an #input_stream object).
+ * Decode a stream (data read from an #InputStream object).
*
* Either implement this method or file_decode(). If
* possible, it is recommended to implement this method,
diff --git a/src/decoder/DecoderThread.cxx b/src/decoder/DecoderThread.cxx
index 6ac7e459f..9ce3ed096 100644
--- a/src/decoder/DecoderThread.cxx
+++ b/src/decoder/DecoderThread.cxx
@@ -60,14 +60,14 @@ decoder_command_finished_locked(DecoderControl &dc)
}
/**
- * Opens the input stream with input_stream::Open(), and waits until
+ * Opens the input stream with InputStream::Open(), and waits until
* the stream gets ready. If a decoder STOP command is received
* during that, it cancels the operation (but does not close the
* stream).
*
* Unlock the decoder before calling this function.
*
- * @return an input_stream on success or if #DecoderCommand::STOP is
+ * @return an InputStream on success or if #DecoderCommand::STOP is
* received, nullptr on error
*/
static InputStream *
diff --git a/src/decoder/plugins/DsdLib.cxx b/src/decoder/plugins/DsdLib.cxx
index 11500b654..8fefbb48c 100644
--- a/src/decoder/plugins/DsdLib.cxx
+++ b/src/decoder/plugins/DsdLib.cxx
@@ -48,7 +48,7 @@ DsdId::Equals(const char *s) const
}
/**
- * Skip the #input_stream to the specified offset.
+ * Skip the #InputStream to the specified offset.
*/
bool
dsdlib_skip_to(Decoder *decoder, InputStream &is,
@@ -64,7 +64,7 @@ dsdlib_skip_to(Decoder *decoder, InputStream &is,
}
/**
- * Skip some bytes from the #input_stream.
+ * Skip some bytes from the #InputStream.
*/
bool
dsdlib_skip(Decoder *decoder, InputStream &is,
diff --git a/src/decoder/plugins/SndfileDecoderPlugin.cxx b/src/decoder/plugins/SndfileDecoderPlugin.cxx
index 68ca20cc7..d8e4b0ba4 100644
--- a/src/decoder/plugins/SndfileDecoderPlugin.cxx
+++ b/src/decoder/plugins/SndfileDecoderPlugin.cxx
@@ -125,7 +125,7 @@ sndfile_vio_tell(void *user_data)
}
/**
- * This SF_VIRTUAL_IO implementation wraps MPD's #input_stream to a
+ * This SF_VIRTUAL_IO implementation wraps MPD's #InputStream to a
* libsndfile stream.
*/
static SF_VIRTUAL_IO vio = {
diff --git a/src/decoder/plugins/WavpackDecoderPlugin.cxx b/src/decoder/plugins/WavpackDecoderPlugin.cxx
index 66d04bbe4..339fd6910 100644
--- a/src/decoder/plugins/WavpackDecoderPlugin.cxx
+++ b/src/decoder/plugins/WavpackDecoderPlugin.cxx
@@ -322,7 +322,7 @@ wavpack_scan_file(Path path_fs,
}
/*
- * mpd input_stream <=> WavpackStreamReader wrapper callbacks
+ * #InputStream <=> WavpackStreamReader wrapper callbacks
*/
/* This struct is needed for per-stream last_byte storage. */
diff --git a/src/input/Init.hxx b/src/input/Init.hxx
index b19bc112f..4ad4ba577 100644
--- a/src/input/Init.hxx
+++ b/src/input/Init.hxx
@@ -23,13 +23,13 @@
class Error;
/**
- * Initializes this library and all input_stream implementations.
+ * Initializes this library and all #InputStream implementations.
*/
bool
input_stream_global_init(Error &error);
/**
- * Deinitializes this library and all input_stream implementations.
+ * Deinitializes this library and all #InputStream implementations.
*/
void input_stream_global_finish(void);
diff --git a/src/input/TextInputStream.hxx b/src/input/TextInputStream.hxx
index 6b3a18d0b..d0b5d5f40 100644
--- a/src/input/TextInputStream.hxx
+++ b/src/input/TextInputStream.hxx
@@ -30,10 +30,10 @@ class TextInputStream {
public:
/**
- * Wraps an existing #input_stream object into a #TextInputStream,
+ * Wraps an existing #InputStream object into a #TextInputStream,
* to read its contents as text lines.
*
- * @param _is an open #input_stream object
+ * @param _is an open #InputStream object
*/
explicit TextInputStream(InputStream &_is)
:is(_is) {}
diff --git a/src/playlist/PlaylistRegistry.hxx b/src/playlist/PlaylistRegistry.hxx
index 6b10b035f..c79718047 100644
--- a/src/playlist/PlaylistRegistry.hxx
+++ b/src/playlist/PlaylistRegistry.hxx
@@ -57,7 +57,7 @@ playlist_list_open_stream_suffix(InputStream &is, const char *suffix);
/**
* Opens a playlist from an input stream.
*
- * @param is an #input_stream object which is open and ready
+ * @param is an #InputStream object which is open and ready
* @param uri optional URI which was used to open the stream; may be
* used to select the appropriate playlist plugin
*/
diff --git a/src/playlist/PlaylistStream.hxx b/src/playlist/PlaylistStream.hxx
index 9f77cbea1..4e441c345 100644
--- a/src/playlist/PlaylistStream.hxx
+++ b/src/playlist/PlaylistStream.hxx
@@ -31,7 +31,7 @@ class Path;
* Opens a playlist from a local file.
*
* @param path the path of the playlist file
- * @param is_r on success, an input_stream object is returned here,
+ * @param is_r on success, an #InputStream object is returned here,
* which must be closed after the playlist_provider object is freed
* @return a playlist, or nullptr on error
*/