From e60f6f8e6726e229342a06ff874f6d52c22105b3 Mon Sep 17 00:00:00 2001 From: trialuser02 Date: Wed, 9 Feb 2011 20:20:26 +0000 Subject: fixed api documentation git-svn-id: http://svn.code.sf.net/p/qmmp-dev/code/trunk/qmmp@2042 90c681e8-e032-0410-971d-27865f9a5e38 --- src/qmmp/abstractengine.h | 8 ++++++-- src/qmmp/eqsettings.h | 41 ++++++++++++++++++++++++++++++++++++----- src/qmmp/soundcore.h | 7 ++++++- src/qmmpui/playlistmodel.h | 2 +- 4 files changed, 49 insertions(+), 9 deletions(-) (limited to 'src') diff --git a/src/qmmp/abstractengine.h b/src/qmmp/abstractengine.h index 007288d1f..5c0b7eaaf 100644 --- a/src/qmmp/abstractengine.h +++ b/src/qmmp/abstractengine.h @@ -79,8 +79,12 @@ public: * Returns wait condition pointer. */ QWaitCondition *cond(); - - + /*! + * Creates Engine object. + * @param s InputSource object. + * @param parent Parent object. + * Returns \b 0 if the given source is not supported. + */ static AbstractEngine *create(InputSource *s, QObject *parent = 0); /*! * Returns a list of decoder factories. diff --git a/src/qmmp/eqsettings.h b/src/qmmp/eqsettings.h index b08a6753d..8bd5c8f39 100644 --- a/src/qmmp/eqsettings.h +++ b/src/qmmp/eqsettings.h @@ -1,5 +1,5 @@ /*************************************************************************** - * Copyright (C) 2010 by Ilya Kotov * + * Copyright (C) 2010-2011 by Ilya Kotov * * forkotov02@hotmail.ru * * * * This program is free software; you can redistribute it and/or modify * @@ -21,28 +21,59 @@ #ifndef EQSETTINGS_H #define EQSETTINGS_H +/*! @brief The EqSettings class helps to work with equalizer settings. + * @author Ilya Kotov + */ class EqSettings { public: + /*! + * Constructs an empty equalizer settings (0 dB, disabled) + */ EqSettings(); - + /*! + * Returns \b true if equalizer os enabled, otherwise returns \b false. + */ bool isEnabled() const; + /*! + * Returns gain of the channel number \b chan. + */ double gain(int chan) const; + /*! + * Returns equalizer preamp. + */ double preamp() const; + /*! + * Enables equalizer if \p enabled is \b true or disables it if \p enabled is \b false. + */ void setEnabled(bool enabled = true); + /*! + * Sets gain of the equalizer channel. + * @param chan Number of equalizer channel. + * @param gain Channel gain (-20.0..20.0 dB) + */ void setGain(int chan, double gain); + /*! + * Sets equalizer preamp to \b preamp. + */ void setPreamp(double preamp); - + /*! + * Assigns equalizer settings \b s to this settings. + */ void operator=(const EqSettings &s); + /*! + * Returns \b true if equalizer settins \b s is equal to this settings; otherwise returns false. + */ bool operator==(const EqSettings &s) const; + /*! + * Returns \b true if equalizer settins \b s is not equal to this settings; otherwise returns false. + */ bool operator!=(const EqSettings &s) const; - private: double m_gain[10]; double m_preamp; bool m_is_enabled; - }; #endif // EQSETTINGS_H diff --git a/src/qmmp/soundcore.h b/src/qmmp/soundcore.h index 2e44ee6ac..aef2896ce 100644 --- a/src/qmmp/soundcore.h +++ b/src/qmmp/soundcore.h @@ -54,8 +54,13 @@ public: * Returns length in milliseconds */ qint64 totalTime() const; - + /*! + * Returns equalizer settings + */ EqSettings eqSettings() const; + /*! + * Chages equalizer settings to \b settings. + */ void setEqSettings(const EqSettings &settings); /*! diff --git a/src/qmmpui/playlistmodel.h b/src/qmmpui/playlistmodel.h index 3e4c1219d..fcfefca83 100644 --- a/src/qmmpui/playlistmodel.h +++ b/src/qmmpui/playlistmodel.h @@ -300,7 +300,7 @@ signals: void currentChanged(); /*! * Emitted when new item has added. - * @param name New playlist item pointer. + * @param item New playlist item pointer. */ void itemAdded(PlayListItem *item); /*! -- cgit v1.2.3-13-gbd6f