From: Wonsik Jung Date: Fri, 1 Sep 2023 00:23:48 +0000 (+0900) Subject: Modify function description in window. X-Git-Tag: dali_2.2.51~3^2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=refs%2Fchanges%2F12%2F298112%2F3;p=platform%2Fcore%2Fuifw%2Fdali-adaptor.git Modify function description in window. Windows modules are not handled by one developer, but by multiple developers in various fields. As a result, coding rules and function descriptions are poorly written compared to other modules. This patch is a supplement to these parts. The function description of the header file of the window-impl and window render surface, which are common modules of the window, has been checked and modified. the format is as follows. 1. Internal function { @brief @param[in] @return } 2. override function { @copydoc } 1 internal function is described, and the contents description of function description, @param[in] input parameter, description of return value. Number 2 describes the overridden function, and the main description is defined in the header file of the inherited class. As the DALi of the Rendering Engine is changed from the Public Interface to the internal module, the description creation or management in the header file is becoming poor. This is to correct this, increase readability, and strengthen communication. Currently, we have only performed for window common modules, but we plan to communicate with the person in charge so that they can be applied to other modules in Dali in the future. Change-Id: Ifa04220d176dde50cdc6132826019a99f1021491 --- diff --git a/dali/internal/window-system/common/window-impl.h b/dali/internal/window-system/common/window-impl.h index 99611db..83908bf 100644 --- a/dali/internal/window-system/common/window-impl.h +++ b/dali/internal/window-system/common/window-impl.h @@ -80,6 +80,7 @@ public: /** * @brief Create a new Window. This should only be called once by the Application class + * * @param[in] name The window title * @param[in] className The window class name * @param[in] windowData The window data @@ -89,6 +90,7 @@ public: /** * @brief Create a new Window. This should only be called once by the Application class + * * @param[in] surface The surface used to render on. * @param[in] name The window title * @param[in] className The window class name @@ -104,6 +106,7 @@ public: /** * @brief Gets the window class name. + * * @return The class of the window */ std::string GetClassName() const; @@ -180,6 +183,7 @@ public: /** * @brief Get window resource ID assigned by window manager + * * @return The resource ID of the window */ std::string GetNativeResourceId() const; @@ -426,6 +430,7 @@ public: /** * @brief Emit the accessibility highlight signal. + * * The highlight indicates that it is an object to interact with the user regardless of focus. * After setting the highlight on the object, you can do things that the object can do, such as * giving or losing focus. @@ -560,6 +565,7 @@ public: // Dali::Internal::Adaptor::SceneHolder private: /** * @brief Enumeration for orietation mode. + * * The Orientation Mode is related to screen size. * If screen width is longer than height, the Orientation Mode will have LANDSCAPE. * Otherwise screen width is shorter than height or same, the Orientation Mode will have PORTRAIT. @@ -582,37 +588,54 @@ private: ~Window() override; /** - * Second stage initialization + * @brief Second stage initialization + * + * @param[in] surface The surface used to render on. + * @param[in] positionSize The window's position and size in initailized time. + * @param[in] name The window title + * @param[in] className The window class name + * @param[in] type window's type. Refer the WindowType in window-enumerations.h. */ void Initialize(Any surface, const PositionSize& positionSize, const std::string& name, const std::string& className, WindowType type); /** - * Called when the window becomes iconified or deiconified. + * @brief Called when the window becomes iconified or deiconified. + * + * @param[in] iconified true If the window is iconified, othewise false. */ void OnIconifyChanged(bool iconified); /** - * Called when the window becomes maximized or unmaximized. + * @brief Called when the window becomes maximized or unmaximized. + * + * @param[in] maximized true If the window is maximized, othewise false. */ void OnMaximizeChanged(bool maximized); /** - * Called when the window focus is changed. + * @brief Called when the window focus is changed. + * + * @param[in] focusIn true If the window is focused, othewise false. */ void OnFocusChanged(bool focusIn); /** - * Called when the output is transformed. + * @brief Called when the output is transformed. */ void OnOutputTransformed(); /** - * Called when the window receives a delete request. + * @brief Called when the window receives a delete request. */ void OnDeleteRequest(); /** - * Called when the window receives a Transition effect-start/end event. + * @brief Called when the window receives a Transition effect-start/end event. + * + * This event is emitted by display server. + * + * @param[in] state current window transition effect state, refer the WindowEffectState in window-enumerations.h. + * @param[in] type current window transition effect type, refer the WindowEffectType in window-enumerations.h. */ void OnTransitionEffectEvent(WindowEffectState state, WindowEffectType type); @@ -658,7 +681,7 @@ private: void OnAccessibilityDisabled(); /** - * Called when the window rotation is finished. + * @brief Called when the window rotation is finished. * * This signal is emmit when window rotation is finisehd and WindowRotationCompleted() is called. */ @@ -666,12 +689,14 @@ private: /** * @brief Called when the mouse in or out event is received. + * * @param[in] mouseInOutEvent the mouse event */ void OnMouseInOutEvent(const Dali::DevelWindow::MouseInOutEvent& mouseInOutEvent); /** * @brief Called when the mouse relative event is received. + * * @param[in] mouseRelativeEvent the mouse event */ void OnMouseRelativeEvent(const Dali::DevelWindow::MouseRelativeEvent& mouseRelativeEvent); @@ -721,6 +746,7 @@ private: /** * @brief Sets user geometry flag when window's geometry is changed. + * * Window is created with screen size or not. * If window is created with screen size or the geometry is changed by user, * client should inform to server setting user.geometry flag @@ -801,7 +827,9 @@ public: // Signals } /** - * This signal is emitted when the window is requesting to be deleted + * @brief This signal is emitted when the window is requesting to be deleted + * + * It is internal signal in Dali-adaptor. */ SignalType& DeleteRequestSignal() { diff --git a/dali/internal/window-system/common/window-render-surface.h b/dali/internal/window-system/common/window-render-surface.h index 5141164..371ff6b 100644 --- a/dali/internal/window-system/common/window-render-surface.h +++ b/dali/internal/window-system/common/window-render-surface.h @@ -54,7 +54,8 @@ public: using DamagedRectsContainer = std::vector>; /** - * Uses an window surface to render to. + * @brief Uses an window surface to render to. + * * @param [in] positionSize the position and size of the surface * @param [in] surface can be a window or pixmap. * @param [in] isTransparent if it is true, surface has 32 bit color depth, otherwise, 24 bit @@ -69,12 +70,14 @@ public: public: // API /** * @brief Get the native window handle + * * @return The native window handle */ Any GetNativeWindow(); /** * @brief Get the native window id + * * @return The native window id */ int GetNativeWindowId(); @@ -86,18 +89,21 @@ public: // API /** * @brief Sets the render notification trigger to call when render thread is completed a frame + * * @param renderNotification to use */ void SetRenderNotification(TriggerEventInterface* renderNotification); /** * @brief Sets whether the surface is transparent or not. + * * @param[in] transparent Whether the surface is transparent */ void SetTransparency(bool transparent); /** - * Request surface rotation + * @brief Request surface rotation + * * @param[in] angle A new angle of the surface * @param[in] positionSize A new position and size of the surface */ @@ -105,13 +111,13 @@ public: // API /** * @brief Gets the window base object + * * @return The window base object */ WindowBase* GetWindowBase(); /** * @brief Intiailize Ime Surface for Ime window rendering. - * * It sets one flag and callback function for Ime window rendering * This callback function calls one special native window function for ready to commit buffer. * The special function notify to display server. @@ -122,7 +128,6 @@ public: // API /** * @brief Sets the necessary for window rotation acknowledge. * After this function called, SendRotationCompletedAcknowledgement() should be called to complete window rotation. - * * More detail description is written in DevelWindow::SetNeedsRotationCompletedAcknowledgement(). * * @param[in] window The window instance. @@ -163,6 +168,7 @@ public: // from Dali::RenderSurfaceInterface PositionSize GetPositionSize() const override; /** + * @copydoc Dali::RenderSurfaceInterface::GetDpi() */ void GetDpi(unsigned int& dpiHorizontal, unsigned int& dpiVertical) override; @@ -258,7 +264,7 @@ private: void Initialize(Any surface); /** - * Notify output is transformed. + * @brief Notify output is transformed. */ void OutputTransformed(); @@ -275,6 +281,7 @@ private: /** * @brief Called when our event file descriptor has been written to. + * * @param[in] eventBitMask bit mask of events that occured on the file descriptor * @param[in] fileDescriptor The file descriptor */ @@ -282,6 +289,7 @@ private: /** * @brief Set the buffer damage rects. + * * @param[in] damagedRects List of damaged rects * @param[in] clippingRect The rect to clip rendered scene */ @@ -289,6 +297,7 @@ private: /** * @brief Swap buffers. + * * @param[in] damagedRects List of damaged rects */ void SwapBuffers(const std::vector>& damagedRects);