oysteikt/mpd
0
0
Fork 0
Code Issues Pull Requests Releases Activity

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

Browse Source
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
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
src/decoder/DecoderControl.hxx
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. * Caller must lock the object.
*/ */

6
src/player/Control.hxx
View File

@ -340,7 +340,7 @@ private:
public: public:
/** /**
* Throws std::runtime_error or #Error on error. * Throws on error.
* *
* @param song the song to be queued * @param song the song to be queued
*/ */
@ -467,7 +467,7 @@ private:
void EnqueueSongLocked(std::unique_ptr<DetachedSong> song) noexcept; 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); 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. * 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 * @param song the song to be queued; the given instance will be owned
* and freed by the player * and freed by the player

18
src/queue/Playlist.hxx
View File

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