player/Control, ...: remove API documentation references to the obsolete Error class

This commit is contained in:
Max Kellermann 2017-12-20 12:20:09 +01:00
parent 36899dba0b
commit 7d035edf9d
3 changed files with 13 additions and 13 deletions

View File

@ -283,7 +283,7 @@ struct DecoderControl {
}
/**
* Clear the error condition and free the #Error object (if any).
* Clear the error condition (if any).
*
* Caller must lock the object.
*/

View File

@ -340,7 +340,7 @@ private:
public:
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*
* @param song the song to be queued
*/
@ -467,7 +467,7 @@ private:
void EnqueueSongLocked(std::unique_ptr<DetachedSong> song) noexcept;
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void SeekLocked(std::unique_ptr<DetachedSong> song, SongTime t);
@ -481,7 +481,7 @@ public:
/**
* Makes the player thread seek the specified song to a position.
*
* Throws std::runtime_error or #Error on error.
* Throws on error.
*
* @param song the song to be queued; the given instance will be owned
* and freed by the player

View File

@ -276,46 +276,46 @@ public:
void Stop(PlayerControl &pc);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void PlayPosition(PlayerControl &pc, int position);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void PlayOrder(PlayerControl &pc, unsigned order);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void PlayId(PlayerControl &pc, int id);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void PlayNext(PlayerControl &pc);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void PlayPrevious(PlayerControl &pc);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void SeekSongOrder(PlayerControl &pc,
unsigned song_order,
SongTime seek_time);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void SeekSongPosition(PlayerControl &pc,
unsigned sonag_position,
SongTime seek_time);
/**
* Throws std::runtime_error or #Error on error.
* Throws on error.
*/
void SeekSongId(PlayerControl &pc,
unsigned song_id, SongTime seek_time);
@ -324,7 +324,7 @@ public:
* Seek within the current song. Fails if MPD is not currently
* playing.
*
* Throws std::runtime_error or #Error on error.
* Throws on error.
*
* @param seek_time the time
* @param relative if true, then the specified time is relative to the