TizenRefApp-9686 [Gallery] Add doxygen documentation to Presenters base classes

Change-Id: I1e741c956018bb94fb87488ed15412fb72dcdeb7

diff --git a/gallery/presenters/base/Dialog.h b/gallery/presenters/base/Dialog.h
index 3092f689427f2135ca56661b916b3261b9f2beb4..8615414219a799c9adc5e0b53cab848df50ceed5 100644 (file)
--- a/gallery/presenters/base/Dialog.h
+++ b/gallery/presenters/base/Dialog.h
@@ -25,31 +25,71 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(Dialog);
 
+       /**
+        * @brief Base dialog class
+        */
        class Dialog : public ucl::GuiPresenter,
                        public ucl::IDisposable {
        public:
+               /**
+                * @brief Opens dialog
+                */
                void open();
+
+               /**
+                * @brief Dismisses dialog
+                */
                void dismiss();
 
                // ucl::IDisposable //
 
+               /**
+                * @brief Disposes dialog
+                */
                virtual void dispose() final override;
+
+               /**
+                * @brief Checks whether the object is already disposed
+                * @return true if disposed, false if not disposed
+                */
                virtual bool isDisposed() const final override;
 
        protected:
+
+               /**
+                * @brief Enumeration of popup types
+                */
                enum class PopupType {
-                       NORMAL,
-                       CONTEXT
+                       NORMAL,   /**< Normal popup*/
+                       CONTEXT   /**< Context popup*/
                };
 
        protected:
+               /**
+                * @brief Constructor
+                * @param[in] rc Pointer to IRefCountObj (passed automatically)
+                */
                Dialog(ucl::IRefCountObj &rc);
+
+               /**
+                * @brief Default destructor
+                */
                virtual ~Dialog() = default;
 
+               /**
+                * @brief Prepares dialog data
+                * @param[in] parent Parent widget
+                * @param[in] popupType Popup type
+                * @param[in] onPrepare Prepare callback
+                * @return RES_OK on success, otherwise an error code on failure
+                */
                template <class ON_PREPARE>
                ucl::Result prepare(ucl::ElmWidget &parent, PopupType popupType,
                                ON_PREPARE &&onPrepare);
 
+               /**
+                * @brief Back key signal callback
+                */
                virtual void onBackKey();
 
        private:

diff --git a/gallery/presenters/base/Page.h b/gallery/presenters/base/Page.h
index 357a36efe1194d15ee725cc22c4fece736d67859..a25d0ccb5cfbd4499505b9fc09ea2b930a859358 100644 (file)
--- a/gallery/presenters/base/Page.h
+++ b/gallery/presenters/base/Page.h
@@ -25,46 +25,123 @@ namespace gallery {
 
        UCL_DECLARE_REF_ALIASES(Page);
 
+       /**
+        * @brief Base class for Pages
+        */
        class Page : public ucl::GuiPresenter,
                        public ucl::IDisposable {
        public:
+               /**
+                * @brief Exit request handler type
+                */
                using ExitRequestHandler = ucl::WeakDelegate<void(Page &page)>;
 
        public:
+               /**
+                * @brief Gets naviframe. @see ucl::Naviframe
+                * @return Naviframe object
+                */
                ucl::Naviframe &getNaviframe();
 
+               /**
+                * @brief Checks if Page is at top of stack
+                * @return true if at top
+                */
                bool isAtTop() const;
+
+               /**
+                * @brief Checks if Page is at bottom of stack
+                * @return true if at bottom
+                */
                bool isAtBottom() const;
 
+               /**
+                * @brief Closes current page
+                */
                void exit();
 
+               /**
+                * @brief Pops pages of the naviframe till this page
+                */
                void popTo();
+
+               /**
+                * @brief Deletes pages of the naviframe till this page
+                */
                void deleteTo();
+
+               /**
+                * @brief Promotes page to the top of the page stack
+                */
                void promote();
 
+               /**
+                * @brief Inserts NaviItem after this page. @see Naviframe::insertAfter
+                * @param[in] args Insertion parameters
+                * @return New NaviItem
+                */
                template <class ...ARGS>
                ucl::NaviItem insertAfter(ARGS &&...args);
 
+               /**
+                * @brief Inserts NaviItem before this page.
+                *        @see Naviframe::insertBefore
+                * @param[in] args Insertion parameters
+                * @return New NaviItem
+                */
                template <class ...ARGS>
                ucl::NaviItem insertBefore(ARGS &&...args);
 
                // ucl::IDisposable //
 
+               /**
+                * @brief Disposes object
+                */
                virtual void dispose() override;
+
+               /**
+                * @brief Checks if object disposed
+                */
                virtual bool isDisposed() const final override;
 
+
        protected:
+               /**
+                * @brief Constructor
+                * @param[in] rc Pointer to IRefCountObj (passed automatically)
+                * @param[in] navi Shared reference to Naviframe object
+                * @param[in] onExitRequest Exit request handler
+                */
                Page(ucl::IRefCountObj &rc, const ucl::NaviframeSRef &navi,
                                const ExitRequestHandler &onExitRequest);
+
+               /**
+                * @brief Default destructor
+                */
                virtual ~Page();
 
+               /**
+                * @brief Prepares content
+                * @param[in] onPrepare Prepare callback
+                * @param[in] contentFlags Content flags
+                */
                template <class ON_PREPARE>
                ucl::Result prepare(ON_PREPARE &&onPrepare);
 
+               /**
+                * @brief Gets NaviItem
+                * @return NaviItem object
+                */
                ucl::NaviItem getItem();
 
+               /**
+                * @brief Requests application exit
+                */
                void requestExit();
 
+               /**
+                * @brief Back key callback
+                */
                virtual void onBackKey();
 
        private: