decoder/sndfile, ...: update API documentation

This commit is contained in:
Max Kellermann
2015-01-31 22:17:15 +01:00
parent e2e66404d5
commit eb1733609a
9 changed files with 13 additions and 13 deletions

View File

@@ -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,

View File

@@ -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 *

View File

@@ -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,

View File

@@ -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 = {

View File

@@ -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. */