TizenRefApp-9716[Gallery] Add doxygen documentation to Presenters pages classes

Change-Id: Icd42b815135e9774c3060ac2508282b07cf68784

diff --git a/gallery/presenters/pages/NoContentPage.h b/gallery/presenters/pages/NoContentPage.h
index 26e64dd54badbe7e84fe872d380cec84b5c806d8..95c75c55cd24dc45cb971b9eae0a8ef1537a6f96 100644 (file)
--- a/gallery/presenters/pages/NoContentPage.h
+++ b/gallery/presenters/pages/NoContentPage.h
@@ -23,13 +23,41 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(NoContentPage);
 
+       /**
+        * @brief Page with no content
+        */
        class NoContentPage final : public Page {
        public:
+
+               /**
+                * @brief Provides set of instruments for creation of NoContentPage
+                *  object with set of options
+                */
                class Builder final {
                public:
+
+                       /**
+                        * @brief Default constructor
+                        */
                        Builder();
+
+                       /**
+                        * @brief Destructor
+                        */
                        ~Builder();
+
+                       /**
+                        * @brief Sets naviframe object
+                        * @param[in] navi Shared reference to naviframe object
+                        * @return Reference to Builder object
+                        */
                        Builder &setNaviframe(const ucl::NaviframeSRef &navi);
+
+                       /**
+                        * @brief Creates NoContentPage object
+                        * @param[in] onExitRequest Exit request handler
+                        * @return Weak reference to NoContentPage object
+                        */
                        NoContentPageWRef build(
                                        const ExitRequestHandler &onExitRequest) const;
                private:

diff --git a/gallery/presenters/pages/PreviewPage.h b/gallery/presenters/pages/PreviewPage.h
index a0c4f263308fc744be6dca6c0f851adf8657b9e8..f936382bf1748b9b59730427e5f9fd7d2c2d6883 100644 (file)
--- a/gallery/presenters/pages/PreviewPage.h
+++ b/gallery/presenters/pages/PreviewPage.h
@@ -34,26 +34,80 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(PreviewPage);
 
+       /**
+        * @brief Page with preview
+        */
        class PreviewPage final : public Page,
                        private ImageGrid::IListener,
                        private MoreOptionsPresenter::IListener,
                        private SelectModePresenter::IListener {
        public:
+               /**
+                * @brief Enumeration of modes
+                */
                enum class Mode {
-                       NORMAL,
-                       SELECT,
-                       OPERATION_VIEW
+                       NORMAL,         /**< Normal mode*/
+                       SELECT,         /**< Select mode*/
+                       OPERATION_VIEW  /**< Operation view mode*/
                };
 
+               /**
+                * @brief Provides set of instruments for creation of PreviewPage
+                *  object with set of options
+                */
                class Builder final {
                public:
+
+                       /**
+                        * @brief Default constructor
+                        */
                        Builder();
+
+                       /**
+                        * @brief Destructor
+                        */
                        ~Builder();
+
+                       /**
+                        * @brief Sets naviframe object
+                        * @param[in] navi Shared reference to naviframe object
+                        * @return Reference to Builder object
+                        */
                        Builder &setNaviframe(const ucl::NaviframeSRef &navi);
+
+                       /**
+                        * @brief Sets album object
+                        * @param[in] album Shared reference to album object
+                        * @return Reference to Builder object
+                        */
                        Builder &setAlbum(const IMediaAlbumSRef &album);
+
+                       /**
+                        * @brief Sets startup mode
+                        * @param[in] value Mode value
+                        * @return Reference to Builder object
+                        */
                        Builder &setStartupMode(Mode value);
+
+                       /**
+                        * @brief Sets startup item index
+                        * @param[in] index Item index
+                        * @return Reference to Builder object
+                        */
                        Builder &setStartItemIndex(int index);
+
+                       /**
+                        * @brief Sets start item autoselection
+                        * @param[in] value Start item autoselection flag
+                        * @return Reference to Builder object
+                        */
                        Builder &setAutoSelectStartItem(bool value);
+
+                       /**
+                        * @brief Creates PreviewPage object
+                        * @param[in] onExitRequest Exit request handler
+                        * @return Weak reference to PreviewPage object
+                        */
                        PreviewPageWRef build(
                                        const ExitRequestHandler &onExitRequest) const;
                private:
@@ -65,6 +119,11 @@ namespace gallery {
                };
 
        public:
+
+                       /**
+                        * @brief Gets current item index
+                        * @return Current item index
+                        */
                int getCurrentItemIndex() const;
 
        private:

diff --git a/gallery/presenters/pages/ThumbnailPage.h b/gallery/presenters/pages/ThumbnailPage.h
index 169c405dd07f380982a66ae7eb7af157566c64f6..4c311435aceca88728fdd7b3b1c8b18a68748e86 100644 (file)
--- a/gallery/presenters/pages/ThumbnailPage.h
+++ b/gallery/presenters/pages/ThumbnailPage.h
@@ -30,16 +30,49 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(ThumbnailPage);
 
+       /**
+        * @brief Page with media thumbnails
+        */
        class ThumbnailPage final : public Page,
                        private ImageGrid::IListener,
                        private MoreOptionsPresenter::IListener {
        public:
+
+               /**
+                * @brief Provides set of instruments for creation of ThumbnailPage
+                *  object with set of options
+                */
                class Builder final {
                public:
+                       /**
+                        * @brief Default constructor
+                        */
                        Builder();
+
+                       /**
+                        * @brief Destructor
+                        */
                        ~Builder();
+
+                       /**
+                        * @brief Sets naviframe object
+                        * @param[in] navi Shared reference to naviframe object
+                        * @return Reference to Builder object
+                        */
                        Builder &setNaviframe(const ucl::NaviframeSRef &navi);
+
+                       /**
+                        * @brief Sets album object
+                        * @param[in] album Shared reference to album object
+                        * @return Reference to Builder object
+                        */
                        Builder &setAlbum(const IMediaAlbumSRef &album);
+
+                       /**
+                        * @brief Creates ThumbnailPage object
+                        * @param[in] onExitRequest Exit request handler
+                        * @return Weak reference to ThumbnailPage object
+                        */
                        ThumbnailPageWRef build(
                                        const ExitRequestHandler &onExitRequest) const;
                private:

diff --git a/gallery/presenters/pages/VideoPlayerPage.h b/gallery/presenters/pages/VideoPlayerPage.h
index d8e3db5307a109123172c74bc29cc6dc43cc3ae7..d11a7342e0e4a1f03e8bca62b45b80919e72705a 100644 (file)
--- a/gallery/presenters/pages/VideoPlayerPage.h
+++ b/gallery/presenters/pages/VideoPlayerPage.h
@@ -34,14 +34,48 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(VideoPlayerPage);
 
+       /**
+        * @brief Page with video player
+        */
        class VideoPlayerPage final : public Page {
        public:
+
+               /**
+                * @brief Provides set of instruments for creation of VideoPlayerPage
+                *  object with set of options
+                */
                class Builder final {
                public:
+
+                       /**
+                        * @brief Default constructor
+                        */
                        Builder();
+
+                       /**
+                        * @brief Destructor
+                        */
                        ~Builder();
+
+                       /**
+                        * @brief Sets naviframe object
+                        * @param[in] navi Shared reference to naviframe object
+                        * @return Reference to Builder object
+                        */
                        Builder &setNaviframe(const ucl::NaviframeSRef &navi);
+
+                       /**
+                        * @brief Sets MediaItem object
+                        * @param[in] media Shared reference to MediaItem object
+                        * @return Reference to Builder object
+                        */
                        Builder &setMedia(const MediaItemSRef &media);
+
+                       /**
+                        * @brief Creates VideoPlayerPage object
+                        * @param[in] onExitRequest Exit request handler
+                        * @return Weak reference to VideoPlayerPage object
+                        */
                        VideoPlayerPageWRef build(
                                        const ExitRequestHandler &onExitRequest) const;
                private:

diff --git a/gallery/presenters/pages/ViewerPage.h b/gallery/presenters/pages/ViewerPage.h
index a155ce747212c072f7e3dede9759994097b6b62a..708bad0542ec3b9310b787888e09ba55716bc8a8 100644 (file)
--- a/gallery/presenters/pages/ViewerPage.h
+++ b/gallery/presenters/pages/ViewerPage.h
@@ -28,17 +28,71 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(ViewerPage);
 
+       /**
+        * @brief Image viewer page
+        */
        class ViewerPage final : public Page {
        public:
+
+               /**
+                * @brief Provides set of instruments for creation of ViewerPage
+                *  object with set of options
+                */
                class Builder final {
                public:
+
+                       /**
+                        * @brief Default constructor
+                        */
                        Builder();
+
+                       /**
+                        * @brief Destructor
+                        */
                        ~Builder();
+
+                       /**
+                        * @brief Sets naviframe object
+                        * @param[in] navi Shared reference to naviframe object
+                        * @return Reference to Builder object
+                        */
                        Builder &setNaviframe(const ucl::NaviframeSRef &navi);
+
+                       /**
+                        * @brief Sets MediaItem object
+                        * @param[in] media Shared reference to MediaItem object
+                        * @return Reference to Builder object
+                        */
                        Builder &setMedia(const MediaItemSRef &media);
+
+                       /**
+                        * @brief Sets zoom values
+                        * @param[in] x X axis value
+                        * @param[in] y Y axis value
+                        * @return Reference to Builder object
+                        */
                        Builder &setZoomIn(int x, int y);
+
+                       /**
+                        * @brief Sets image load size
+                        * @param[in] size Image load size
+                        * @param[in] isFull Full size flag
+                        * @return Reference to Builder object
+                        */
                        Builder &setImageLoadSize(int size, bool isFull);
+
+                       /**
+                        * @brief Sets "Exit on ZoomOut" flag
+                        * @param[in] value Flag value
+                        * @return Reference to Builder object
+                        */
                        Builder &setExitOnZoomOut(bool value);
+
+                       /**
+                        * @brief Creates ViewerPage object
+                        * @param[in] onExitRequest Exit request handler
+                        * @return Weak reference to ViewerPage object
+                        */
                        ViewerPageWRef build(
                                        const ExitRequestHandler &onExitRequest) const;
                private:
@@ -52,6 +106,11 @@ namespace gallery {
                };
 
        public:
+
+               /**
+                * @brief Gets media item ID
+                * @return MediaItem ID
+                */
                const std::string &getMediaId() const;
 
        private: