added Doxygen

2018-11-07 13:08:42 +01:00
parent 1fb97e1891
commit 8f63d174f3
34 changed files with 6133 additions and 235 deletions
@@ -10,20 +10,47 @@ namespace Ui {
 class cEpisodeDetails;
 }

+/*!
+ \brief
+
+ \class cEpisodeDetails cepisodedetails.h "cepisodedetails.h"
+*/
 class cEpisodeDetails : public QWidget
 {
 	Q_OBJECT

 public:
+	/*!
+	 \brief
+
+	 \fn cEpisodeDetails
+	 \param parent
+	*/
 	explicit cEpisodeDetails(QWidget *parent = 0);
+	/*!
+	 \brief
+
+	 \fn ~cEpisodeDetails
+	*/
 	~cEpisodeDetails();

+	/*!
+	 \brief
+
+	 \fn setEpisode
+	 \param lpEpisode
+	*/
 	void					setEpisode(cEpisode* lpEpisode);
+	/*!
+	 \brief
+
+	 \fn loadImages
+	*/
 	void					loadImages();
 private:
-	Ui::cEpisodeDetails*	ui;
-	cEpisode*				m_lpEpisode;
-	bool					m_bLoaded;
+	Ui::cEpisodeDetails*	ui; /*!< TODO: describe */
+	cEpisode*				m_lpEpisode; /*!< TODO: describe */
+	bool					m_bLoaded; /*!< TODO: describe */
 };

 #endif // CEPISODEDETAILS_H