1
0
mirror of https://github.com/tomahawk-player/tomahawk.git synced 2025-08-14 01:54:07 +02:00

* Let's start doxygen-ing new classes.

This commit is contained in:
Christian Muehlhaeuser
2011-07-03 17:04:49 +02:00
parent dc095ec963
commit 15cdc8f910
2 changed files with 19 additions and 1 deletions

View File

@@ -57,7 +57,7 @@ InfoBar::InfoBar( QWidget* parent )
ui->captionLabel->setMargin( 6 );
ui->descriptionLabel->setMargin( 6 );
ui->longDescriptionLabel->setMargin( 6 );
ui->longDescriptionLabel->setMargin( 4 );
ui->captionLabel->setText( QString() );
ui->descriptionLabel->setText( QString() );

View File

@@ -16,6 +16,16 @@
* along with Tomahawk. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* \class ArtistInfoWidget
* \brief A ViewPage class, which displays top-hits, related artists and albums.
*
* This Tomahawk ViewPage displays top-hits, related artists and known albums
* for any given artist. It is our default ViewPage when showing an artist
* via ViewManager.
*
*/
#ifndef ARTISTINFOWIDGET_H
#define ARTISTINFOWIDGET_H
@@ -45,6 +55,14 @@ public:
ArtistInfoWidget( const Tomahawk::artist_ptr& artist, QWidget* parent = 0 );
~ArtistInfoWidget();
/** \brief Load information for a given artist.
* \param artist The artist that you want to load information for.
*
* Calling this method will make ArtistInfoWidget load information about
* an artist's top hits, related artists and all available albums. It is
* automatically called by the constructor, but you can use it to load
* another artist's information at any point.
*/
void load( const Tomahawk::artist_ptr& artist );
virtual QWidget* widget() { return this; }