From bb16cf83b65d25a586cc01b561e84d6c5ad46185 Mon Sep 17 00:00:00 2001 From: Edouard DUPIN Date: Tue, 23 Mar 2021 09:08:06 +0100 Subject: [PATCH] [DEV] continue rework --- old_widget/Button.java | 18 +- old_widget/ButtonColor.java | 16 +- old_widget/CheckBox.java | 16 +- old_widget/Composer.java | 18 +- old_widget/Container2.java | 68 +++---- old_widget/Entry.java | 30 +-- old_widget/Gird.java | 64 +++--- old_widget/Joystick.java | 20 +- old_widget/Layer.java | 4 +- old_widget/List.java | 20 +- old_widget/ListFileSystem.java | 12 +- old_widget/PopUp.java | 6 +- old_widget/Select.java | 8 +- old_widget/Spin.java | 10 +- old_widget/TreeView.java | 12 +- old_widget/WSlider.java | 20 +- old_widget/WidgetScrolled.java | 44 ++--- old_widget/meta/FileChooser.java | 2 +- old_widget/meta/SpinBase.java | 6 +- old_widget/meta/StdPopUp.java | 14 +- src/org/atriasoft/echrono/Clock.java | 2 +- src/org/atriasoft/echrono/Steady.java | 2 +- src/org/atriasoft/echrono/Time.java | 2 +- src/org/atriasoft/etranslate/ETranslate.java | 38 ++-- src/org/atriasoft/ewol/Ewol.java | 8 +- src/org/atriasoft/ewol/Gravity.java | 2 +- src/org/atriasoft/ewol/Padding.java | 2 +- .../ewol/compositing/Compositing.java | 22 +-- .../ewol/compositing/CompositingDrawing.java | 90 ++++----- .../ewol/compositing/CompositingImage.java | 72 +++---- src/org/atriasoft/ewol/compositing/Text.java | 6 +- .../atriasoft/ewol/compositing/TextBase.java | 186 +++++++++--------- .../atriasoft/ewol/context/ConfigFont.java | 30 +-- .../ewol/context/EwolApplication.java | 28 +-- .../atriasoft/ewol/context/EwolContext.java | 30 +-- .../atriasoft/ewol/context/InputManager.java | 34 ++-- src/org/atriasoft/ewol/event/EventInput.java | 2 +- src/org/atriasoft/ewol/internal/Tools.java | 4 +- src/org/atriasoft/ewol/object/EwolObject.java | 50 ++--- .../atriasoft/ewol/object/ObjectManager.java | 36 ++-- src/org/atriasoft/ewol/object/Worker.java | 4 +- .../resource/RefactorColored3DObject.java | 2 +- .../ewol/resource/ResourceColorFile.java | 20 +- .../ewol/resource/ResourceConfigFile.java | 4 +- .../ewol/resource/ResourceTexture2.java | 14 +- .../ewol/resource/ResourceTextureFile.java | 8 +- .../ewol/resource/ResourceTexturedFont.java | 30 +-- .../ewol/resource/font/GlyphProperty.java | 4 +- .../atriasoft/ewol/resource/font/Kerning.java | 10 +- src/org/atriasoft/ewol/tools/Message.java | 22 +-- src/org/atriasoft/ewol/widget/Container.java | 20 +- src/org/atriasoft/ewol/widget/ContainerN.java | 30 +-- src/org/atriasoft/ewol/widget/Image.java | 14 +- src/org/atriasoft/ewol/widget/Label.java | 6 +- src/org/atriasoft/ewol/widget/Sizer.java | 4 +- src/org/atriasoft/ewol/widget/Spacer.java | 2 +- .../atriasoft/ewol/widget/WidgetManager.java | 42 ++-- src/org/atriasoft/ewol/widget/Windows.java | 18 +- 58 files changed, 654 insertions(+), 654 deletions(-) diff --git a/old_widget/Button.java b/old_widget/Button.java index e7d8b72..52dcf8d 100644 --- a/old_widget/Button.java +++ b/old_widget/Button.java @@ -22,7 +22,7 @@ namespace ewol { using Button = ememory::Ptr; using ButtonWeak = ememory::WeakPtr; /** - * @brief a composed button is a button with an inside composed with the specify XML element + * a composed button is a button with an inside composed with the specify XML element * ==> this permit to generate standard element simple */ class Button : public ewol::widget::Container2 { @@ -50,15 +50,15 @@ namespace ewol { ewol::compositing::Shaper this.shaper; //!< Compositing theme. protected: /** - * @brief Constructor - * @param[in] _shaperName Shaper file properties + * Constructor + * @param _shaperName Shaper file properties */ Button(); void init() ; public: DECLARE_WIDGET_FACTORY(Button, "Button"); /** - * @brief Destructor + * Destructor */ ~Button(); private: @@ -69,12 +69,12 @@ namespace ewol { Vector2f this.selectableAreaSize; //!< size of the event positions private: /** - * @brief internal system to change the property of the current status - * @param[in] _newStatusId new state + * internal system to change the property of the current status + * @param _newStatusId new state */ void changeStatusIn(int _newStatusId); /** - * @brief update the status with the internal satte of the button ... + * update the status with the internal satte of the button ... */ void CheckStatus(); protected: // Derived function @@ -91,8 +91,8 @@ namespace ewol { protected: esignal::Connection this.PCH; //!< Periodic Call Handle to remove it when needed /** - * @brief Periodic call to update grapgic display - * @param[in] _event Time generic event + * Periodic call to update grapgic display + * @param _event Time generic event */ void periodicCall( ewol::event::Time _event); void onLostFocus() ; diff --git a/old_widget/ButtonColor.java b/old_widget/ButtonColor.java index a084438..c9836ec 100644 --- a/old_widget/ButtonColor.java +++ b/old_widget/ButtonColor.java @@ -37,16 +37,16 @@ namespace ewol { Vector2f this.selectableAreaSize; //!< size of the event positions protected: /** - * @brief Main ructor. - * @param[in] _baseColor basic displayed color. - * @param[in] _shaperName The new shaper filename. + * Main ructor. + * @param _baseColor basic displayed color. + * @param _shaperName The new shaper filename. */ ButtonColor(); void init() ; public: DECLARE_WIDGET_FACTORY(ButtonColor, "ButtonColor"); /** - * @brief Main destructor. + * Main destructor. */ ~ButtonColor(); protected: @@ -57,14 +57,14 @@ namespace ewol { boolean onEventInput( ewol::event::Input _event) ; private: /** - * @brief internal system to change the property of the current status - * @param[in] _newStatusId new state + * internal system to change the property of the current status + * @param _newStatusId new state */ void changeStatusIn(int _newStatusId); esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed /** - * @brief Periodic call to update grapgic display - * @param[in] _event Time generic event + * Periodic call to update grapgic display + * @param _event Time generic event */ void periodicCall( ewol::event::Time _event); // Callback function: diff --git a/old_widget/CheckBox.java b/old_widget/CheckBox.java index 86f8fbd..2214ce3 100644 --- a/old_widget/CheckBox.java +++ b/old_widget/CheckBox.java @@ -40,25 +40,25 @@ namespace ewol { int this.shaperIdSizeInsize; protected: /** - * @brief Main checkbox ructor - * @param[in] _shaperName Shaper file properties + * Main checkbox ructor + * @param _shaperName Shaper file properties */ CheckBox(); void init() ; public: DECLARE_WIDGET_FACTORY(CheckBox, "CheckBox"); /** - * @brief main destructor. + * main destructor. */ ~CheckBox(); protected: /** - * @brief internal system to change the property of the current status - * @param[in] _newStatusId new state + * internal system to change the property of the current status + * @param _newStatusId new state */ void changeStatusIn(int _newStatusId); /** - * @brief update the status with the internal satte of the button ... + * update the status with the internal satte of the button ... */ void CheckStatus(); protected: @@ -72,8 +72,8 @@ namespace ewol { protected: esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed /** - * @brief Periodic call to update grapgic display - * @param[in] _event Time generic event + * Periodic call to update grapgic display + * @param _event Time generic event */ void periodicCall( ewol::event::Time _event); protected: diff --git a/old_widget/Composer.java b/old_widget/Composer.java index ae72d5a..c8c8063 100644 --- a/old_widget/Composer.java +++ b/old_widget/Composer.java @@ -17,7 +17,7 @@ namespace ewol { using ComposerWeak = ememory::WeakPtr; /** * @ingroup ewolWidgetGroup - * @brief the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree + * the composer widget is a widget that create a link on a string.file to parse the data and generate some widget tree */ class Composer : public ewol::widget::Container { public: @@ -25,27 +25,27 @@ namespace ewol { eproperty::Value propertySubFile; //!< If loading a sub-file, we must do it here ==> permit to configure it in the xml and not have wrong display protected: /** - * @brief Constructor + * Constructor */ Composer(); public: DECLARE_WIDGET_FACTORY(Composer, "Composer"); /** - * @brief Destructor + * Destructor */ ~Composer(); /** - * @brief load a composition with a file - * @param[in] _uri Name of the file - * @param[in] _id Unique ID that is used in replacing the balise "{ID}" inside the File (do nothing if == 0) + * load a composition with a file + * @param _uri Name of the file + * @param _id Unique ID that is used in replacing the balise "{ID}" inside the File (do nothing if == 0) * @return true == > all done OK * @return false == > some error occured */ boolean loadFromFile( etk::Uri _uri, ulong _id=0); /** - * @brief load a composition with a file - * @param[in] _composerXmlString xml to parse directly - * @param[in] _id Unique ID that is used in replacing the balise "{ID}" inside the String (do nothing if == 0) + * load a composition with a file + * @param _composerXmlString xml to parse directly + * @param _id Unique ID that is used in replacing the balise "{ID}" inside the String (do nothing if == 0) * @return true == > all done OK * @return false == > some error occured */ diff --git a/old_widget/Container2.java b/old_widget/Container2.java index 11b9ce9..a36228a 100644 --- a/old_widget/Container2.java +++ b/old_widget/Container2.java @@ -17,7 +17,7 @@ namespace ewol { using Container2Weak = ememory::WeakPtr; /** * @ingroup ewolWidgetGroup - * @brief the Cotainer widget is a widget that have an only one subWidget + * the Cotainer widget is a widget that have an only one subWidget */ class Container2 : public Widget { protected: @@ -25,42 +25,42 @@ namespace ewol { int this.idWidgetDisplayed; //!< current widget displayed protected: /** - * @brief Constructor - * @param[in] _subElement Widget to set on the normal position - * @param[in] _subElementToggle Widget to set on the toggle position + * Constructor + * @param _subElement Widget to set on the normal position + * @param _subElementToggle Widget to set on the toggle position */ Container2(); public: /** - * @brief Destructor + * Destructor */ ~Container2(); private: /** - * @brief Specify the current widget - * @param[in] _subWidget Widget to add normal - * @param[in] _idWidget Id of the widget to set + * Specify the current widget + * @param _subWidget Widget to add normal + * @param _idWidget Id of the widget to set */ void setSubWidget(Widget _subWidget, int _idWidget); public: /** - * @brief Specify the current widget - * @param[in] _subWidget Widget to add normal + * Specify the current widget + * @param _subWidget Widget to add normal */ void setSubWidget(Widget _subWidget) { setSubWidget(_subWidget, 0); } /** - * @brief Specify the current toggle widget - * @param[in] _subWidget Widget to add Toggle + * Specify the current toggle widget + * @param _subWidget Widget to add Toggle */ void setSubWidgetToggle(Widget _subWidget) { setSubWidget(_subWidget, 1); } private: /** - * @brief get the current displayed composition - * @param[in] _idWidget Id of the widget to set + * get the current displayed composition + * @param _idWidget Id of the widget to set * @return The base widget */ Widget getSubWidget(int _idWidget) { @@ -68,14 +68,14 @@ namespace ewol { }; public: /** - * @brief get the current displayed composition + * get the current displayed composition * @return The base widget */ Widget getSubWidget() { return getSubWidget(0); }; /** - * @brief get the current displayed composition + * get the current displayed composition * @return The toggle widget */ Widget getSubWidgetToggle() { @@ -83,63 +83,63 @@ namespace ewol { }; private: /** - * @brief remove the subWidget node (async). - * @param[in] _idWidget Id of the widget to set + * remove the subWidget node (async). + * @param _idWidget Id of the widget to set */ void subWidgetRemove(int _idWidget); public: /** - * @brief remove the subWidget node (async). + * remove the subWidget node (async). */ void subWidgetRemove() { subWidgetRemove(0); } /** - * @brief remove the subWidget Toggle node (async). + * remove the subWidget Toggle node (async). */ void subWidgetRemoveToggle() { subWidgetRemove(1); } private: /** - * @brief Unlink the subwidget Node. - * @param[in] _idWidget Id of the widget to set + * Unlink the subwidget Node. + * @param _idWidget Id of the widget to set */ void subWidgetUnLink(int _idWidget); public: /** - * @brief Unlink the subwidget Node. + * Unlink the subwidget Node. */ void subWidgetUnLink() { subWidgetUnLink(0); } /** - * @brief Unlink the subwidget Toggle Node. + * Unlink the subwidget Toggle Node. */ void subWidgetUnLinkToggle() { subWidgetUnLink(1); } protected: /** - * @brief Parent set the possible diplay size of the current widget whith his own possibilities + * Parent set the possible diplay size of the current widget whith his own possibilities * By default this save the widget available size in the widget size - * @param[in] _padding Padding of the widget. + * @param _padding Padding of the widget. * @note : INTERNAL EWOL SYSTEM */ ewol::Padding onChangeSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0)); /** - * @brief calculate the minimum and maximum size (need to estimate expend properties of the widget) - * @param[in] _padding Padding of the widget. + * calculate the minimum and maximum size (need to estimate expend properties of the widget) + * @param _padding Padding of the widget. * @note : INTERNAL EWOL SYSTEM */ void calculateMinMaxSizePadded( ewol::Padding _padding = ewol::Padding(0,0,0,0)); /** - * @brief Called when parsing a XML and detect the presence of a second Widget + * Called when parsing a XML and detect the presence of a second Widget */ void onDetectPresenceToggleWidget() {} /** - * @brief convert ID of the widget if not existed - * @param[in] _id Id of the widget to display. + * convert ID of the widget if not existed + * @param _id Id of the widget to display. * @return the id of the widget displayable */ int convertId(int _id) { @@ -149,9 +149,9 @@ namespace ewol { return _id; } /** - * @brief Replace a old subwidget with a new one. - * @param[in] _oldWidget The widget to replace. - * @param[in] _newWidget The widget to set. + * Replace a old subwidget with a new one. + * @param _oldWidget The widget to replace. + * @param _newWidget The widget to set. */ void subWidgetReplace( Widget _oldWidget, Widget _newWidget); diff --git a/old_widget/Entry.java b/old_widget/Entry.java index fabc5e0..cb5bbd0 100644 --- a/old_widget/Entry.java +++ b/old_widget/Entry.java @@ -23,7 +23,7 @@ namespace ewol { using EntryWeak = ememory::WeakPtr; /** * @ingroup ewolWidgetGroup - * @brief Entry box display : + * Entry box display : * * ~~~~~~~~~~~~~~~~~~~~~~ * ---------------------------------------------- @@ -52,21 +52,21 @@ namespace ewol { ewol::compositing::Text this.text; //!< text display this.text protected: /** - * @brief Contuctor - * @param[in] _newData The USting that might be set in the Entry box (no event generation!!) + * Contuctor + * @param _newData The USting that might be set in the Entry box (no event generation!!) */ Entry(); void init() ; public: DECLARE_WIDGET_FACTORY(Entry, "Entry"); /** - * @brief Destuctor + * Destuctor */ ~Entry(); protected: /** - * @brief internal check the value with RegExp checking - * @param[in] _newData The new string to display + * internal check the value with RegExp checking + * @param _newData The new string to display */ void setInternalValue( String _newData); private: @@ -79,28 +79,28 @@ namespace ewol { int this.displayCursorPosSelection; //!< Selection position end (can be befor or after cursor and == this.displayCursorPos chan no selection availlable protected: /** - * @brief informe the system thet the text change and the start position change + * informe the system thet the text change and the start position change */ void markToUpdateTextPosition(); /** - * @brief update the display position start == > depending of the position of the Cursor and the size of the Data inside + * update the display position start == > depending of the position of the Cursor and the size of the Data inside * @change this.displayStartPosition < == updated */ void updateTextPosition(); /** - * @brief change the cursor position with the curent position requested on the display - * @param[in] _pos Absolute position of the event + * change the cursor position with the curent position requested on the display + * @param _pos Absolute position of the event * @note The display is automaticly requested when change apear. */ void updateCursorPosition( Vector2f _pos, boolean _Selection=false); public: /** - * @brief Copy the selected data on the specify clipboard - * @param[in] _clipboardID Selected clipboard + * Copy the selected data on the specify clipboard + * @param _clipboardID Selected clipboard */ void copySelectionToClipBoard(enum gale::context::clipBoard::clipboardListe _clipboardID); /** - * @brief remove the selected area + * remove the selected area * @note This request a regeneration of the display */ void removeSelected(); @@ -118,8 +118,8 @@ namespace ewol { protected: esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed /** - * @brief Periodic call to update grapgic display - * @param[in] _event Time generic event + * Periodic call to update grapgic display + * @param _event Time generic event */ void periodicCall( ewol::event::Time _event); private: // callback functions diff --git a/old_widget/Gird.java b/old_widget/Gird.java index 97a4c89..5d3da76 100644 --- a/old_widget/Gird.java +++ b/old_widget/Gird.java @@ -35,51 +35,51 @@ namespace ewol { boolean this.gavityButtom; protected: /** - * @brief Constructor + * Constructor */ Gird(); public: DECLARE_WIDGET_FACTORY(Gird, "Gird"); /** - * @brief Desstructor + * Desstructor */ ~Gird(); /** - * @brief set the number of colomn - * @param[in] colNumber Nuber of colomn + * set the number of colomn + * @param colNumber Nuber of colomn */ void setColNumber(int _colNumber); /** - * @brief change a size view of a colomn. - * @param[in] colId Id of the colomn [0..x]. - * @param[in] size size of the colomn. + * change a size view of a colomn. + * @param colId Id of the colomn [0..x]. + * @param size size of the colomn. */ void setColSize(int _colId, int _size); /** - * @brief change a size view of a line. - * @param[in] size size of the line. + * change a size view of a line. + * @param size size of the line. */ void setRowSize(int _size); /** - * @brief get the size view of a colomn. - * @param[in] colId Id of the colomn [0..x]. + * get the size view of a colomn. + * @param colId Id of the colomn [0..x]. * @return The size of the colomn. */ int getColSize(int _colId); /** - * @brief get the size view of the lines. + * get the size view of the lines. * @return The size of the lines. */ int getRowSize(); /** - * @brief set the gravity of the widget on the Button (index 0 is on buttom) + * set the gravity of the widget on the Button (index 0 is on buttom) */ void setGravityButtom() { this.gavityButtom = true; markToRedraw(); } /** - * @brief set the gravity of the widget on the Top (index 0 is on top) + * set the gravity of the widget on the Top (index 0 is on top) */ void setGravityTop() { this.gavityButtom = false; @@ -87,36 +87,36 @@ namespace ewol { } public: /** - * @brief remove all sub element from the widget. + * remove all sub element from the widget. */ void subWidgetRemoveAll(); /** - * @brief add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) - * @param[in] _colId Id of the colomn [0..x]. - * @param[in] _rowId Id of the row [0..y]. - * @param[in] _newWidget the element pointer + * add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) + * @param _colId Id of the colomn [0..x]. + * @param _rowId Id of the row [0..y]. + * @param _newWidget the element pointer */ void subWidgetAdd(int _colId, int _rowId, Widget _newWidget); /** - * @brief remove definitly a widget from the system and this Gird. - * @param[in] _newWidget the element pointer. + * remove definitly a widget from the system and this Gird. + * @param _newWidget the element pointer. */ void subWidgetRemove(Widget _newWidget); /** - * @brief remove definitly a widget from the system and this Gird. - * @param[in] _colId Id of the colomn [0..x]. - * @param[in] _rowId Id of the row [0..y]. + * remove definitly a widget from the system and this Gird. + * @param _colId Id of the colomn [0..x]. + * @param _rowId Id of the row [0..y]. */ void subWidgetRemove(int _colId, int _rowId); /** - * @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). - * @param[in] _newWidget the element pointer. + * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). + * @param _newWidget the element pointer. */ void subWidgetUnLink(Widget _newWidget); /** - * @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). - * @param[in] _colId Id of the colomn [0..x]. - * @param[in] _rowId Id of the row [0..y]. + * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...). + * @param _colId Id of the colomn [0..x]. + * @param _rowId Id of the row [0..y]. */ void subWidgetUnLink(int _colId, int _rowId); private: @@ -124,12 +124,12 @@ namespace ewol { Vector2i this.borderSize; //!< Border size needed for all the display public: /** - * @brief set the current border size of the current element: - * @param[in] _newBorderSize The border size to set (0 if not used) + * set the current border size of the current element: + * @param _newBorderSize The border size to set (0 if not used) */ void setBorderSize( Vector2i _newBorderSize); /** - * @brief get the current border size of the current element: + * get the current border size of the current element: * @return the border size (0 if not used) */ Vector2i getBorderSize() { diff --git a/old_widget/Joystick.java b/old_widget/Joystick.java index 7850295..94b3881 100644 --- a/old_widget/Joystick.java +++ b/old_widget/Joystick.java @@ -59,25 +59,25 @@ namespace ewol { this.displayMode = _newMode; }; /** - * @brief set the ratio of the widget joystick - * @param[in] _newRatio the new ratio that might be set + * set the ratio of the widget joystick + * @param _newRatio the new ratio that might be set */ void ratio(float _newRatio); /** - * @brief set the Background of the widget joystick - * @param[in] _imageNameInData the new rbackground that might be set - * @param[in] _display + * set the Background of the widget joystick + * @param _imageNameInData the new rbackground that might be set + * @param _display */ void background(String _imageNameInData, boolean _display=true); /** - * @brief set the Foreground of the widget joystick - * @param[in] _imageNameInData the new Foreground that might be set + * set the Foreground of the widget joystick + * @param _imageNameInData the new Foreground that might be set */ void foreground(String _imageNameInData); /** - * @brief get the property of the joystick - * @param[out] _distance distance to the center - * @param[out] _angle angle of the joy + * get the property of the joystick + * @param _distance distance to the center + * @param _angle angle of the joy */ void getProperty(float _distance, float _angle); diff --git a/old_widget/Layer.java b/old_widget/Layer.java index c3989f1..0acc1dc 100644 --- a/old_widget/Layer.java +++ b/old_widget/Layer.java @@ -21,13 +21,13 @@ namespace ewol { class Layer : public ewol::widget::ContainerN { protected: /** - * @brief Constructor + * Constructor */ Layer(); public: DECLARE_WIDGET_FACTORY(Layer, "Layer"); /** - * @brief Desstructor + * Desstructor */ ~Layer(); public: diff --git a/old_widget/List.java b/old_widget/List.java index b593212..a6bf1a6 100644 --- a/old_widget/List.java +++ b/old_widget/List.java @@ -70,7 +70,7 @@ namespace ewol { } /** - * @brief Get the number of colomn and row availlable in the list + * Get the number of colomn and row availlable in the list * @return Number of colomn and row */ Vector2i getMatrixSize() ; @@ -90,22 +90,22 @@ namespace ewol { return fluorine::Variant(); }; /** - * @brief Calculate an element size to extimate the render size. + * Calculate an element size to extimate the render size. * @note Does not generate the with the same size. - * @param[in] _pos Position of colomn and Raw of the element. + * @param _pos Position of colomn and Raw of the element. * @return The estimate size of the element. */ Vector2f calculateElementSize( Vector2i _pos); /** - * @brief Draw an element in the specific size and position. - * @param[in] _pos Position of colomn and Raw of the element. - * @param[in] _start Start display position. - * @param[in] _size Render raw size + * Draw an element in the specific size and position. + * @param _pos Position of colomn and Raw of the element. + * @param _start Start display position. + * @param _size Render raw size * @return The estimate size of the element. */ void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size); /** - * @brief Draw the background + * Draw the background */ void drawBackground(); @@ -113,8 +113,8 @@ namespace ewol { return false; } /** - * @brief set a raw visible in the main display - * @param[in] _id Id of the raw that might be visible. + * set a raw visible in the main display + * @param _id Id of the raw that might be visible. */ //void setRawVisible(int _id); protected: diff --git a/old_widget/ListFileSystem.java b/old_widget/ListFileSystem.java index 1a9ea86..a94d5cc 100644 --- a/old_widget/ListFileSystem.java +++ b/old_widget/ListFileSystem.java @@ -15,7 +15,7 @@ namespace ewol { using ListFileSystem = ememory::Ptr; using ListFileSystemWeak = ememory::WeakPtr; /** - * @brief Generic display folder class. This widget display the content of a single folder : + * Generic display folder class. This widget display the content of a single folder : */ class ListFileSystem : public ewol::widget::List { public: // signals @@ -49,23 +49,23 @@ namespace ewol { protected: List this.list; //!< List of all element in the path. (they are filtered) /** - * @brief Clean the list of element. + * Clean the list of element. */ void clearList(); /** - * @brief Regenerate the content of the view. this is actually not automation on the system update. + * Regenerate the content of the view. this is actually not automation on the system update. */ void regenerateView(); protected: int this.selectedLine; //!< Current Line ID that is selected public: /** - * @brief Select a specific file in the path - * @param[in] _data File to selested. + * Select a specific file in the path + * @param _data File to selested. */ void setSelect( etk::Path _data); /** - * @brief Get the current selected file/folder/... in the list + * Get the current selected file/folder/... in the list * @return the String of the element selected. */ etk::Path getSelect() ; diff --git a/old_widget/PopUp.java b/old_widget/PopUp.java index 5ffac7e..9a25792 100644 --- a/old_widget/PopUp.java +++ b/old_widget/PopUp.java @@ -28,15 +28,15 @@ namespace ewol { eproperty::Value propertyCloseOutEvent; //!< ratio progression of a sliding protected: /** - * @brief Constructor - * @param[in] _shaperName Shaper file properties + * Constructor + * @param _shaperName Shaper file properties */ PopUp(); void init() ; public: DECLARE_WIDGET_FACTORY(PopUp, "PopUp"); /** - * @brief Destructor + * Destructor */ ~PopUp(); protected: diff --git a/old_widget/Select.java b/old_widget/Select.java index 8158488..6419e4f 100644 --- a/old_widget/Select.java +++ b/old_widget/Select.java @@ -15,7 +15,7 @@ namespace ewol { using Select = ememory::Ptr; using SelectWeak = ememory::WeakPtr; /** - * @brief a composed Select is a Select with an inside composed with the specify XML element + * a composed Select is a Select with an inside composed with the specify XML element * ==> this permit to generate standard element simple */ class Select : public ewol::widget::SpinBase { @@ -25,14 +25,14 @@ namespace ewol { eproperty::Value propertyValue; //!< Current state of the Select. protected: /** - * @brief Constructor - * @param[in] _shaperName Shaper file properties + * Constructor + * @param _shaperName Shaper file properties */ Select(); public: DECLARE_WIDGET_FACTORY(Select, "Select"); /** - * @brief Destructor + * Destructor */ ~Select(); protected: diff --git a/old_widget/Spin.java b/old_widget/Spin.java index ea58159..bd7db76 100644 --- a/old_widget/Spin.java +++ b/old_widget/Spin.java @@ -15,7 +15,7 @@ namespace ewol { using Spin = ememory::Ptr; using SpinWeak = ememory::WeakPtr; /** - * @brief a composed Spin is a Spin with an inside composed with the specify XML element + * a composed Spin is a Spin with an inside composed with the specify XML element * ==> this permit to generate standard element simple */ class Spin : public ewol::widget::SpinBase { @@ -31,15 +31,15 @@ namespace ewol { eproperty::Value propertyMantis; //!< number of value under '.' value protected: /** - * @brief Constructor - * @param[in] _mode mode to display the spin - * @param[in] _shaperName Shaper file properties + * Constructor + * @param _mode mode to display the spin + * @param _shaperName Shaper file properties */ Spin(); public: DECLARE_WIDGET_FACTORY(Spin, "Spin"); /** - * @brief Destructor + * Destructor */ ~Spin(); protected: diff --git a/old_widget/TreeView.java b/old_widget/TreeView.java index fb0a7e3..5cc8427 100644 --- a/old_widget/TreeView.java +++ b/old_widget/TreeView.java @@ -34,17 +34,17 @@ namespace ewol { ~TreeView(); protected: /** - * @brief Calculate an element size to extimate the render size. + * Calculate an element size to extimate the render size. * @note Does not generate the with the same size. - * @param[in] _pos Position of colomn and Raw of the element. + * @param _pos Position of colomn and Raw of the element. * @return The estimate size of the element. */ Vector2f calculateElementSize( Vector2i _pos) ; /** - * @brief Draw an element in the specific size and position. - * @param[in] _pos Position of colomn and Raw of the element. - * @param[in] _start Start display position. - * @param[in] _size Render raw size + * Draw an element in the specific size and position. + * @param _pos Position of colomn and Raw of the element. + * @param _start Start display position. + * @param _size Render raw size * @return The estimate size of the element. */ void drawElement( Vector2i _pos, Vector2f _start, Vector2f _size) ; diff --git a/old_widget/WSlider.java b/old_widget/WSlider.java index d10c8d2..1f975ad 100644 --- a/old_widget/WSlider.java +++ b/old_widget/WSlider.java @@ -45,24 +45,24 @@ namespace ewol { float this.slidingProgress; //!< ratio progression of a sliding protected: /** - * @brief Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...) - * @param[in] _id Id in the vector + * Generate the move on the specific vector ID (This is not a public acces, because the vector can have some null pointer inside ...) + * @param _id Id in the vector */ void subWidgetSelectSetVectorId(int _id); public: /** - * @brief Select a new subwidget to display - * @param[in] _id Id of the subwidget requested + * Select a new subwidget to display + * @param _id Id of the subwidget requested */ void subWidgetSelectSet(int _id); /** - * @brief Select a new subwidget to display - * @param[in] _widgetPointer Pointer on the widget selected (must be added before) + * Select a new subwidget to display + * @param _widgetPointer Pointer on the widget selected (must be added before) */ void subWidgetSelectSet( Widget _widgetPointer); /** - * @brief Select a new subwidget to display - * @param[in] _widgetName Name of the subwidget name + * Select a new subwidget to display + * @param _widgetName Name of the subwidget name */ void subWidgetSelectSet( String _widgetName); public: @@ -73,8 +73,8 @@ namespace ewol { protected: esignal::Connection this.PCH; //!< Periodic call handle to remove it when needed /** - * @brief Periodic call to update grapgic display - * @param[in] _event Time generic event + * Periodic call to update grapgic display + * @param _event Time generic event */ void periodicCall( ewol::event::Time _event); protected: diff --git a/old_widget/WidgetScrolled.java b/old_widget/WidgetScrolled.java index 0b19318..acc8fec 100644 --- a/old_widget/WidgetScrolled.java +++ b/old_widget/WidgetScrolled.java @@ -19,7 +19,7 @@ namespace ewol { using WidgetScrolled = ememory::Ptr; using WidgetScrolledWeak = ememory::WeakPtr; /** - * @brief Widget to integrate a scrool bar in a widget. This is not a stadalone widget. + * Widget to integrate a scrool bar in a widget. This is not a stadalone widget. */ class WidgetScrolled : public Widget { public: // properties: @@ -50,12 +50,12 @@ namespace ewol { boolean this.singleFingerMode; //!< in many case the moving in a subwidget is done with one finger, it is enought ==> the user select... public: /** - * @brief Set the single finger capabilities/ - * @param[in] _status True if single inger mode, two otherwise/ + * Set the single finger capabilities/ + * @param _status True if single inger mode, two otherwise/ */ void setSingleFinger(boolean _status); /** - * @brief Get the single finger capabilities + * Get the single finger capabilities * @return true The single finger mode is active * @return false The To finger mode is active */ @@ -63,7 +63,7 @@ namespace ewol { return this.singleFingerMode; } /** - * @brief Reset the scoll of the subWidget + * Reset the scoll of the subWidget */ void resetScrollOrigin() { this.originScrooled = Vector2f(0,0); @@ -74,15 +74,15 @@ namespace ewol { Vector2f this.fingerMoveStartPos[CALCULATE_SIMULTANEOUS_FINGER]; protected: /** - * @brief Scroll Widget main ructor to be herited from an other widget (this is not a stand-alone widget) - * @param[in] _shaperName Shaper name if the scrolled widget. + * Scroll Widget main ructor to be herited from an other widget (this is not a stand-alone widget) + * @param _shaperName Shaper name if the scrolled widget. */ WidgetScrolled(); void init() ; public: DECLARE_WIDGET_FACTORY(WidgetScrolled, "WidgetScrolled"); /** - * @brief Scroll widget destructor. + * Scroll widget destructor. */ ~WidgetScrolled(); protected: @@ -93,42 +93,42 @@ namespace ewol { void systemDraw( ewol::DrawProperty _displayProp) ; protected: /** - * @brief For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled - * @param[in] _nbPixel number of pixel scrolling + * For mouse event when we have a scrolling UP and dows, specify the number of pixel that we scrooled + * @param _nbPixel number of pixel scrolling */ void setScrollingSize(float _nbPixel) { this.pixelScrolling = _nbPixel; }; /** - * @brief Specify the mode of scrolling for this windows - * @param[in] _newMode the selected mode for the scrolling... + * Specify the mode of scrolling for this windows + * @param _newMode the selected mode for the scrolling... */ void scroolingMode(enum scrollingMode _newMode); /** - * @brief set the specific mawimum size of the widget - * @param[in] _localSize new Maximum size + * set the specific mawimum size of the widget + * @param _localSize new Maximum size */ void setMaxSize( Vector2f _localSize) { this.maxSize = _localSize; }; /** - * @brief Request a specific position for the scrolling of the current windows. - * @param[in] _borderWidth size of the border that requested the element might not to be - * @param[in] _currentPosition Position that is requested to view - * @param[in] _center True if the position might be at the center of the widget + * Request a specific position for the scrolling of the current windows. + * @param _borderWidth size of the border that requested the element might not to be + * @param _currentPosition Position that is requested to view + * @param _center True if the position might be at the center of the widget */ void setScrollingPositionDynamic(Vector2f _borderWidth, Vector2f _currentPosition, boolean _center = false); /** - * @brief set the scrolling limit when arriving at he end of the widget - * @param[in] _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ... + * set the scrolling limit when arriving at he end of the widget + * @param _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end ... */ void setLimitScrolling(float _poucentageLimit) { _poucentageLimit = etk::avg(0.1f, _poucentageLimit,1.0f); this.limitScrolling = Vector2f(_poucentageLimit, _poucentageLimit); }; /** - * @brief set the scrolling limit when arriving at he end of the widget - * @param[in] _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end for axis specific... + * set the scrolling limit when arriving at he end of the widget + * @param _poucentageLimit pourcent of the limit of view nothing in the widget when arriving at the end for axis specific... */ void setLimitScrolling( Vector2f _poucentageLimit) { this.limitScrolling = Vector2f(etk::avg(0.1f, _poucentageLimit.x(),1.0f), etk::avg(0.1f, _poucentageLimit.y(),1.0f)); diff --git a/old_widget/meta/FileChooser.java b/old_widget/meta/FileChooser.java index 8cd15c9..e8fb9e8 100644 --- a/old_widget/meta/FileChooser.java +++ b/old_widget/meta/FileChooser.java @@ -16,7 +16,7 @@ namespace ewol { using FileChooser = ememory::Ptr; using FileChooserWeak = ememory::WeakPtr; /** - * @brief File Chooser is a simple selector of file for opening, saving, and what you want ... + * File Chooser is a simple selector of file for opening, saving, and what you want ... * * As all other pop-up methode ( wost case we can have) the creating is simple , but event back is not all the time simple: * diff --git a/old_widget/meta/SpinBase.java b/old_widget/meta/SpinBase.java index d28882f..68cf84d 100644 --- a/old_widget/meta/SpinBase.java +++ b/old_widget/meta/SpinBase.java @@ -76,14 +76,14 @@ namespace ewol { int this.confIdDownData; protected: /** - * @brief Constructor - * @param[in] _mode The mode to display the elements + * Constructor + * @param _mode The mode to display the elements */ SpinBase(); void init() ; public: /** - * @brief Destructor + * Destructor */ ~SpinBase(); protected: diff --git a/old_widget/meta/StdPopUp.java b/old_widget/meta/StdPopUp.java index 437f0cc..0b7d651 100644 --- a/old_widget/meta/StdPopUp.java +++ b/old_widget/meta/StdPopUp.java @@ -15,7 +15,7 @@ namespace ewol { using StdPopUp = ememory::Ptr; using StdPopUpWeak = ememory::WeakPtr; /** - * @brief The std pop up widget is a siple message widget to notify user of some simple things, like: + * The std pop up widget is a siple message widget to notify user of some simple things, like: * * [pre] * +---------------------------------+---+---+---+ @@ -44,33 +44,33 @@ namespace ewol { eproperty::Value propertyComment; //!< comment in the pop-up (can be decorated text) protected: /** - * @brief std-pop-up ructor. + * std-pop-up ructor. */ StdPopUp(); void init(); public: DECLARE_WIDGET_FACTORY(StdPopUp, "StdPopUp"); /** - * @brief std-pop-up destructor. + * std-pop-up destructor. */ ~StdPopUp(); protected: ewol::widget::Label this.title; //!< Title Label widget /** - * @brief property callback when request a change of the title. + * property callback when request a change of the title. */ void onChangePropertyTitle(); ewol::widget::Label this.comment; //!< Comment label widget /** - * @brief property callback when request a change of the Comment. + * property callback when request a change of the Comment. */ void onChangePropertyComment(); protected: ewol::widget::Sizer this.subBar; //!< subwidget bar containing all the button. public: /** - * @brief Add a buttom button. - * @param[in] _text Decorated text to diplay in button. + * Add a buttom button. + * @param _text Decorated text to diplay in button. */ ewol::widget::Button addButton( String _text, boolean _autoExit=false); public: diff --git a/src/org/atriasoft/echrono/Clock.java b/src/org/atriasoft/echrono/Clock.java index 5defcc4..5c7a5a1 100644 --- a/src/org/atriasoft/echrono/Clock.java +++ b/src/org/atriasoft/echrono/Clock.java @@ -1,7 +1,7 @@ package org.atriasoft.echrono; /** - * @brief Clock is a compleate virtual clock that is used to virtualize the urrent clock used (can be non real-time, ex:for simulation) + * Clock is a compleate virtual clock that is used to virtualize the urrent clock used (can be non real-time, ex:for simulation) */ public class Clock { public static Clock now() { diff --git a/src/org/atriasoft/echrono/Steady.java b/src/org/atriasoft/echrono/Steady.java index e594435..022087d 100644 --- a/src/org/atriasoft/echrono/Steady.java +++ b/src/org/atriasoft/echrono/Steady.java @@ -1,7 +1,7 @@ package org.atriasoft.echrono; /** - * @brief Steady is a Program start time clock + * Steady is a Program start time clock */ public class Steady { public static Steady now() { diff --git a/src/org/atriasoft/echrono/Time.java b/src/org/atriasoft/echrono/Time.java index 734edb2..6e3671a 100644 --- a/src/org/atriasoft/echrono/Time.java +++ b/src/org/atriasoft/echrono/Time.java @@ -1,7 +1,7 @@ package org.atriasoft.echrono; /** - * @brief Represent the earth clock (if computer is synchronized) + * Represent the earth clock (if computer is synchronized) */ public class Time { public static Time now() { diff --git a/src/org/atriasoft/etranslate/ETranslate.java b/src/org/atriasoft/etranslate/ETranslate.java index 6598b3c..6cb071b 100644 --- a/src/org/atriasoft/etranslate/ETranslate.java +++ b/src/org/atriasoft/etranslate/ETranslate.java @@ -11,7 +11,7 @@ import org.atriasoft.etk.Uri; import org.atriasoft.ewol.internal.Log; /** - * @brief This is a simple interface to converte application display string in a + * This is a simple interface to converte application display string in a * generic current system language * @note: The current name of language reprenent the file name, then if you want * to get the machine language in an other than generic passed, juste add @@ -30,19 +30,19 @@ public class ETranslate { private static boolean g_isInit = false; /** - * @brief Initialize etranslate - * @param[in] _argc Number of argument list - * @param[in] _argv List of arguments + * Initialize etranslate + * @param _argc Number of argument list + * @param _argv List of arguments */ static { } /** - * @brief Set the path folder of the translation files - * @param[in] _lib Library name that the path depend - * @param[in] _uri ETK generic uri (DATA:... or /xxx) - * @param[in] _major This path is the major path (The last loaded, the one which + * Set the path folder of the translation files + * @param _lib Library name that the path depend + * @param _uri ETK generic uri (DATA:... or /xxx) + * @param _major This path is the major path (The last loaded, the one which * overload all) */ public static void addPath(final String _lib, final Uri _uri) { @@ -60,7 +60,7 @@ public class ETranslate { } /** - * @brief Automatic detection of the system language + * Automatic detection of the system language */ public static void autoDetectLanguage() { if (g_isInit == false) { @@ -98,9 +98,9 @@ public class ETranslate { } /** - * @brief Translate a specific text (if not find, it will be retured the same + * Translate a specific text (if not find, it will be retured the same * text). - * @param[in] _instance Text to translate. + * @param _instance Text to translate. * @return The tranlated text. */ public static String get(final String _instance) { @@ -121,7 +121,7 @@ public class ETranslate { } /** - * @brief Get the current language loaded + * Get the current language loaded * @return The 2/3 char defining the language */ public static String getLanguage() { @@ -129,7 +129,7 @@ public class ETranslate { } /** - * @brief Get the current language selected + * Get the current language selected * @return The 2/3 char defining the language */ public static String getLanguageDefault() { @@ -137,8 +137,8 @@ public class ETranslate { } /** - * @brief Get the current paths of the library - * @param[in] _lib Library name that the path depend + * Get the current paths of the library + * @param _lib Library name that the path depend * @return Uri value. */ public static Uri getPaths(final String _lib) { @@ -225,9 +225,9 @@ public class ETranslate { } /** - * @brief Set the language to load data. when no data availlable, we get the + * Set the language to load data. when no data availlable, we get the * default language. - * @param[in] _lang Language to load : ("EN" for english, "FR" for french, "DE" + * @param _lang Language to load : ("EN" for english, "FR" for french, "DE" * for German, "SP" for spanish ...) */ public static void setLanguage(final String _lang) { @@ -263,9 +263,9 @@ public class ETranslate { } /** - * @brief Set the default language to load data (the default language might + * Set the default language to load data (the default language might * contain all internal data for the basic application) - * @param[in] _lang Language to load : ("EN" for english, "FR" for french, "DE" + * @param _lang Language to load : ("EN" for english, "FR" for french, "DE" * for German, "SP" for spanish ...) */ public static void setLanguageDefault(final String _lang) { diff --git a/src/org/atriasoft/ewol/Ewol.java b/src/org/atriasoft/ewol/Ewol.java index 2882e6f..2a3afaf 100644 --- a/src/org/atriasoft/ewol/Ewol.java +++ b/src/org/atriasoft/ewol/Ewol.java @@ -20,15 +20,15 @@ public class Ewol { } /** - * @brief This is the only one things the User might done in his main(); + * This is the only one things the User might done in his main(); * @note To answare you before you ask the question, this is really simple: * Due to the fect that the current system is multiple-platform, you "main" * Does not exist in the android platform, then ewol call other start * and stop function, to permit to have only one code * @note The main can not be in the ewol, due to the fact thet is an librairy - * @param[in] _application just created instance of the applicationo - * @param[in] _argc Standard argc - * @param[in] _argv Standard argv + * @param _application just created instance of the applicationo + * @param _argc Standard argc + * @param _argv Standard argv * @return normal error int for the application error management */ public static int run(final EwolApplication _application, String[] _argv); diff --git a/src/org/atriasoft/ewol/Gravity.java b/src/org/atriasoft/ewol/Gravity.java index 7098f19..5b9c403 100644 --- a/src/org/atriasoft/ewol/Gravity.java +++ b/src/org/atriasoft/ewol/Gravity.java @@ -8,7 +8,7 @@ package org.atriasoft.ewol; import org.atriasoft.etk.math.Vector2f; /** - * @brief Gravity of the widget property + * Gravity of the widget property */ public enum Gravity { center, // !< gravity is in center diff --git a/src/org/atriasoft/ewol/Padding.java b/src/org/atriasoft/ewol/Padding.java index ae50e94..697d116 100644 --- a/src/org/atriasoft/ewol/Padding.java +++ b/src/org/atriasoft/ewol/Padding.java @@ -35,7 +35,7 @@ public class Padding { } /** - * @brief Add a vector to this one + * Add a vector to this one * @param _v The vector to add to this one */ public Padding add(final Padding _v) { diff --git a/src/org/atriasoft/ewol/compositing/Compositing.java b/src/org/atriasoft/ewol/compositing/Compositing.java index f9392f7..a2f328b 100644 --- a/src/org/atriasoft/ewol/compositing/Compositing.java +++ b/src/org/atriasoft/ewol/compositing/Compositing.java @@ -13,14 +13,14 @@ public abstract class Compositing { protected Matrix4f matrixApply = Matrix4f.IDENTITY;; /** - * @brief clear alll tre registered element in the current element + * clear alll tre registered element in the current element */ public void clear() { this.matrixApply = Matrix4f.IDENTITY; } /** - * @brief Virtal pure function that request the draw of all openGl elements + * Virtal pure function that request the draw of all openGl elements */ public void draw() { draw(true); @@ -29,39 +29,39 @@ public abstract class Compositing { public abstract void draw(final boolean _disableDepthTest); /** - * @brief reset to the eye matrix the openGL mouving system + * reset to the eye matrix the openGL mouving system */ public void resetMatrix() { this.matrixApply = Matrix4f.IDENTITY; } /** - * @brief rotate the curent display of this element - * @param[in] _vect The rotation vector to apply at the transformation matrix + * rotate the curent display of this element + * @param _vect The rotation vector to apply at the transformation matrix */ public void rotate(final Vector3f _vect, final float _angle) { this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixRotate(_vect, _angle)); } /** - * @brief scale the current diaplsy of this element - * @param[in] _vect The scaling vector to apply at the transformation matrix + * scale the current diaplsy of this element + * @param _vect The scaling vector to apply at the transformation matrix */ public void scale(final Vector3f _vect) { this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixScale(_vect)); } /** - * @brief set the transformation matrix - * @param[in] _mat The new matrix. + * set the transformation matrix + * @param _mat The new matrix. */ public void setMatrix(final Matrix4f _mat) { this.matrixApply = _mat; } /** - * @brief translate the current display of this element - * @param[in] _vect The translation vector to apply at the transformation matrix + * translate the current display of this element + * @param _vect The translation vector to apply at the transformation matrix */ public void translate(final Vector3f _vect) { this.matrixApply = this.matrixApply.multiply(Matrix4f.createMatrixTranslate(_vect)); diff --git a/src/org/atriasoft/ewol/compositing/CompositingDrawing.java b/src/org/atriasoft/ewol/compositing/CompositingDrawing.java index dab66f2..e99b372 100644 --- a/src/org/atriasoft/ewol/compositing/CompositingDrawing.java +++ b/src/org/atriasoft/ewol/compositing/CompositingDrawing.java @@ -48,7 +48,7 @@ public class CompositingDrawing extends Compositing { // internal API for the generation abstraction of triangles /** - * @brief Basic ructor + * Basic ructor */ public CompositingDrawing() { loadProgram(); @@ -63,7 +63,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief add a point reference at the current position (this is a vertex + * add a point reference at the current position (this is a vertex * reference at the current position */ public void addVertex() { @@ -72,11 +72,11 @@ public class CompositingDrawing extends Compositing { } /** - * @brief draw a 2D circle with the specify rafdius parameter. - * @param[in] _radius Distence to the dorder - * @param[in] _angleStart start angle of this circle ([0..2PI] otherwithe == > + * draw a 2D circle with the specify rafdius parameter. + * @param _radius Distence to the dorder + * @param _angleStart start angle of this circle ([0..2PI] otherwithe == > * disable) - * @param[in] _angleStop stop angle of this circle ([0..2PI] otherwithe == > + * @param _angleStop stop angle of this circle ([0..2PI] otherwithe == > * disable) */ public void circle(final float _radius) { @@ -150,7 +150,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief clear alll tre registered element in the current element + * clear alll tre registered element in the current element */ @Override public void clear() { @@ -178,7 +178,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief draw All the refistered text in the current element on openGL + * draw All the refistered text in the current element on openGL */ @Override public void draw(final boolean _disableDepthTest) { @@ -208,7 +208,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief Lunch the generation of triangle + * Lunch the generation of triangle */ private void generateTriangle() { this.triElement = 0; @@ -221,7 +221,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief Get the foreground color of the font. + * Get the foreground color of the font. * @return Foreground color. */ public Color getColor() { @@ -229,7 +229,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief Get the background color of the font. + * Get the background color of the font. * @return Background color. */ public Color getColorBg() { @@ -237,7 +237,7 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief get the current display position (sometime needed in the gui control) + * get the current display position (sometime needed in the gui control) * @return the current position. */ public Vector3f getPos() { @@ -245,8 +245,8 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief set the Color of the current triangle drawing - * @param[in] _color Color to current dots generated + * set the Color of the current triangle drawing + * @param _color Color to current dots generated */ private void internalSetColor(final Color _color) { if (this.triElement < 1) { @@ -265,8 +265,8 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief Relative drawing a line (spacial vector) - * @param[in] _vect Vector of the curent line. + * Relative drawing a line (spacial vector) + * @param _vect Vector of the curent line. */ public void lineRel(final Vector3f _vect) { lineTo(this.position.add(_vect)); @@ -277,8 +277,8 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief draw a line to a specific position - * @param[in] _dest Position of the end of the line. + * draw a line to a specific position + * @param _dest Position of the end of the line. */ public void lineTo(final Vector3f _dest) { resetCount(); @@ -315,7 +315,7 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief load the openGL program and get all the ID needed + * load the openGL program and get all the ID needed */ private void loadProgram() { // remove previous loading ... in case @@ -337,8 +337,8 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief draw a 2D rectangle to the position requested. - * @param[in] _dest Position the the end of the rectangle + * draw a 2D rectangle to the position requested. + * @param _dest Position the the end of the rectangle */ public void rectangle(final Vector3f _dest) { resetCount(); @@ -393,15 +393,15 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief draw a 2D rectangle to the requested size. - * @param[in] _size size of the rectangle + * draw a 2D rectangle to the requested size. + * @param _size size of the rectangle */ public void rectangleWidth(final Vector3f _size) { rectangle(this.position.add(_size)); } /** - * @brief in case of some error the count can be reset + * in case of some error the count can be reset */ private void resetCount() { this.triElement = 0; @@ -412,9 +412,9 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief Request a clipping area for the text (next draw only) - * @param[in] _pos Start position of the clipping - * @param[in] _posEnd End position of the clipping + * Request a clipping area for the text (next draw only) + * @param _pos Start position of the clipping + * @param _posEnd End position of the clipping */ public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { // note the internal system all time request to have a bounding all time in the @@ -425,9 +425,9 @@ public class CompositingDrawing extends Compositing { } /** - * @brief enable/Disable the clipping (without lose the current clipping + * enable/Disable the clipping (without lose the current clipping * position) - * @brief _newMode The new status of the clipping + * _newMode The new status of the clipping */ public void setClippingMode(final boolean _newMode) { this.clippingEnable = _newMode; @@ -438,34 +438,34 @@ public class CompositingDrawing extends Compositing { } /** - * @brief Request a clipping area for the text (next draw only) - * @param[in]_ pos Start position of the clipping - * @param[in] _width Width size of the clipping + * Request a clipping area for the text (next draw only) + * @param_ pos Start position of the clipping + * @param _width Width size of the clipping */ public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { setClipping(_pos, _pos.add(_width)); }; /** - * @brief set the Color of the current foreground font - * @param[in] _color Color to set on foreground (for next print) + * set the Color of the current foreground font + * @param _color Color to set on foreground (for next print) */ public void setColor(final Color _color) { this.color = _color; }; /** - * @brief set the background color of the font (for selected Text (not the + * set the background color of the font (for selected Text (not the * global BG)) - * @param[in] _color Color to set on background (for next print) + * @param _color Color to set on background (for next print) */ public void setColorBg(final Color _color) { this.colorBg = _color; }; /** - * @brief internal add of the specific point - * @param[in] _point The requeste dpoint to add + * internal add of the specific point + * @param _point The requeste dpoint to add */ private void setPoint(final Vector3f point) { this.triangle[this.triElement] = point; @@ -481,8 +481,8 @@ public class CompositingDrawing extends Compositing { }; /** - * @brief set position for the next text writen - * @param[in] _pos Position of the text (in 3D) + * set position for the next text writen + * @param _pos Position of the text (in 3D) */ public void setPos(final Vector3f _pos) { this.position = _pos; @@ -493,16 +493,16 @@ public class CompositingDrawing extends Compositing { } /** - * @brief set relative position for the next text writen - * @param[in] _pos ofset apply of the text (in 3D) + * set relative position for the next text writen + * @param _pos ofset apply of the text (in 3D) */ public void setRelPos(final Vector3f _pos) { this.position = this.position.add(_pos); } /** - * @brief Specify the line thickness for the next elements - * @param[in] _thickness The thickness disired for the next print + * Specify the line thickness for the next elements + * @param _thickness The thickness disired for the next print */ public void setThickness(final float _thickness) { this.thickness = _thickness; @@ -513,7 +513,7 @@ public class CompositingDrawing extends Compositing { } /** - * @brief Un-Load the openGL program and get all the ID needed + * Un-Load the openGL program and get all the ID needed */ private void unLoadProgram() { this.GLprogram = null; diff --git a/src/org/atriasoft/ewol/compositing/CompositingImage.java b/src/org/atriasoft/ewol/compositing/CompositingImage.java index 79ba904..7a88ad6 100644 --- a/src/org/atriasoft/ewol/compositing/CompositingImage.java +++ b/src/org/atriasoft/ewol/compositing/CompositingImage.java @@ -49,10 +49,10 @@ class CompositingImage extends Compositing { private ResourceVirtualBufferObject VBO = null; /** - * @brief generic ructor - * @param[in] _uri URI of the file that might be loaded - * @param[in] _df enable distance field mode - * @param[in] _size for the image when Verctorial image loading is requested + * generic ructor + * @param _uri URI of the file that might be loaded + * @param _df enable distance field mode + * @param _size for the image when Verctorial image loading is requested */ public CompositingImage() { this(new Uri(""), sizeAuto); @@ -73,7 +73,7 @@ class CompositingImage extends Compositing { } /** - * @brief clear alll tre registered element in the current element + * clear alll tre registered element in the current element */ @Override public void clear() { @@ -91,8 +91,8 @@ class CompositingImage extends Compositing { } /** - * @brief draw All the refistered text in the current element on openGL - * @param[in] _disableDepthTest disable the Depth test for display + * draw All the refistered text in the current element on openGL + * @param _disableDepthTest disable the Depth test for display */ @Override public void draw(final boolean _disableDepthTest) { @@ -141,7 +141,7 @@ class CompositingImage extends Compositing { } /** - * @brief get the current display position (sometime needed in the gui control) + * get the current display position (sometime needed in the gui control) * @return the current position. */ public Vector3f getPos() { @@ -149,7 +149,7 @@ class CompositingImage extends Compositing { } /** - * @brief get the source image registered size in the file (<0 when multiple size image) + * get the source image registered size in the file (<0 when multiple size image) * @return tre image registered size */ public Vector2i getRealSize() { @@ -166,7 +166,7 @@ class CompositingImage extends Compositing { }; /** - * @brief Sometimes the user declare an image but not allocate the ressources all the time, this is to know it .. + * Sometimes the user declare an image but not allocate the ressources all the time, this is to know it .. * @return the validity od the resources. */ public boolean hasSources() { @@ -174,7 +174,7 @@ class CompositingImage extends Compositing { }; /** - * @brief load the openGL program and get all the ID needed + * load the openGL program and get all the ID needed */ private void loadProgram() { // get the shader resource: @@ -194,18 +194,18 @@ class CompositingImage extends Compositing { } /** - * @brief add a compleate of the image to display with the requested size - * @param[in] _size size of the output image + * add a compleate of the image to display with the requested size + * @param _size size of the output image */ public void print(final Vector2i _size) { print(new Vector2f(_size.x(), _size.y())); }; /** - * @brief add a part of the image to display with the requested size - * @param[in] _size size of the output image - * @param[in] _sourcePosStart Start position in the image [0..1] (can be bigger but this repeate the image). - * @param[in] _sourcePosStop Stop position in the image [0..1] (can be bigger but this repeate the image). + * add a part of the image to display with the requested size + * @param _size size of the output image + * @param _sourcePosStart Start position in the image [0..1] (can be bigger but this repeate the image). + * @param _sourcePosStop Stop position in the image [0..1] (can be bigger but this repeate the image). */ public void printPart(final Vector2f _size, final Vector2f _sourcePosStart, final Vector2f _sourcePosStop) { if (this.resource == null) { @@ -338,8 +338,8 @@ class CompositingImage extends Compositing { }; /** - * @brief set a unique rotation of this element (not set in the rotate Generic system) - * @param[in] _angle Angle to set in radiant. + * set a unique rotation of this element (not set in the rotate Generic system) + * @param _angle Angle to set in radiant. */ public void setAngle(final float _angleRad) { this.angle = _angleRad; @@ -350,9 +350,9 @@ class CompositingImage extends Compositing { }; /** - * @brief Request a clipping area for the text (next draw only) - * @param[in] _pos Start position of the clipping - * @param[in] _posEnd End position of the clipping + * Request a clipping area for the text (next draw only) + * @param _pos Start position of the clipping + * @param _posEnd End position of the clipping */ public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { this.clippingPosStart = FMath.min(_pos, _posEnd); @@ -361,8 +361,8 @@ class CompositingImage extends Compositing { } /** - * @brief enable/Disable the clipping (without lose the current clipping position) - * @brief _newMode The new status of the clipping + * enable/Disable the clipping (without lose the current clipping position) + * _newMode The new status of the clipping */ public void setClippingMode(final boolean _newMode) { this.clippingEnable = _newMode; @@ -373,17 +373,17 @@ class CompositingImage extends Compositing { }; /** - * @brief Request a clipping area for the text (next draw only) - * @param[in] _pos Start position of the clipping - * @param[in] _width Width size of the clipping + * Request a clipping area for the text (next draw only) + * @param _pos Start position of the clipping + * @param _width Width size of the clipping */ public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { setClipping(_pos, _pos.add(_width)); } /** - * @brief set the Color of the current foreground font - * @param[in] _color Color to set on foreground (for next print) + * set the Color of the current foreground font + * @param _color Color to set on foreground (for next print) */ public void setColor(final Color _color) { this.color = _color; @@ -394,8 +394,8 @@ class CompositingImage extends Compositing { } /** - * @brief set position for the next text writen - * @param[in] _pos Position of the text (in 3D) + * set position for the next text writen + * @param _pos Position of the text (in 3D) */ public void setPos(final Vector3f _pos) { this.position = _pos; @@ -406,8 +406,8 @@ class CompositingImage extends Compositing { } /** - * @brief set relative position for the next text writen - * @param[in] _pos ofset apply of the text (in 3D) + * set relative position for the next text writen + * @param _pos ofset apply of the text (in 3D) */ public void setRelPos(final Vector3f _pos) { this.position.add(_pos); @@ -422,9 +422,9 @@ class CompositingImage extends Compositing { } /** - * @brief change the image Source == > can not be done to display 2 images at the same time ... - * @param[in] _uri New file of the Image - * @param[in] _size for the image when Verctorial image loading is requested + * change the image Source == > can not be done to display 2 images at the same time ... + * @param _uri New file of the Image + * @param _size for the image when Verctorial image loading is requested */ public void setSource(final Uri _uri) { setSource(_uri, 32); diff --git a/src/org/atriasoft/ewol/compositing/Text.java b/src/org/atriasoft/ewol/compositing/Text.java index 7d2c374..2998060 100644 --- a/src/org/atriasoft/ewol/compositing/Text.java +++ b/src/org/atriasoft/ewol/compositing/Text.java @@ -30,9 +30,9 @@ class Text extends TextBase { protected float size; /** - * @brief generic ructor - * @param[in] _fontName Name of the font that might be loaded - * @param[in] _fontSize size of the font that might be loaded + * generic ructor + * @param _fontName Name of the font that might be loaded + * @param _fontSize size of the font that might be loaded */ public Text() { this(""); diff --git a/src/org/atriasoft/ewol/compositing/TextBase.java b/src/org/atriasoft/ewol/compositing/TextBase.java index 15630af..96b9095 100644 --- a/src/org/atriasoft/ewol/compositing/TextBase.java +++ b/src/org/atriasoft/ewol/compositing/TextBase.java @@ -84,7 +84,7 @@ public abstract class TextBase extends Compositing { public TextDecoration htmlDecoTmp = new TextDecoration(); // !< current decoration /** - * @brief generic constructor + * generic constructor */ public TextBase() { this(new Uri("DATA", "text.vert", "ewol"), new Uri("DATA", "text.frag", "ewol")); @@ -109,8 +109,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief calculate a theoric charcode size - * @param[in] _charcode The Unicode value to calculate dimention. + * calculate a theoric charcode size + * @param _charcode The Unicode value to calculate dimention. * @return The theoric size used. */ public Vector3f calculateSize(final Character _charcode) { @@ -118,8 +118,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief calculate a theoric text size - * @param[in] _text The string to calculate dimention. + * calculate a theoric text size + * @param _text The string to calculate dimention. * @return The theoric size used. */ public Vector3f calculateSize(final String _text) { @@ -138,8 +138,8 @@ public abstract class TextBase extends Compositing { public abstract Vector3f calculateSizeChar(Character _charcode); /** - * @brief calculate a theoric text size - * @param[in] _text The string to calculate dimention. + * calculate a theoric text size + * @param _text The string to calculate dimention. * @return The theoric size used. */ public Vector3f calculateSizeDecorated(final String _text) { @@ -155,8 +155,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief calculate a theoric text size - * @param[in] _text The string to calculate dimention. + * calculate a theoric text size + * @param _text The string to calculate dimention. * @return The theoric size used. */ public Vector3f calculateSizeHTML(final String _text) { @@ -187,7 +187,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief clear all the registered element in the current element + * clear all the registered element in the current element */ @Override public void clear() { @@ -202,14 +202,14 @@ public abstract class TextBase extends Compositing { } /** - * @brief disable the alignement system + * disable the alignement system */ public void disableAlignement() { this.alignement = AligneMode.alignDisable; } /** - * @brief remove the cursor display + * remove the cursor display */ public void disableCursor() { this.selectionStartPos = -100; @@ -217,7 +217,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief draw All the registered text in the current element on openGL + * draw All the registered text in the current element on openGL */ @Override public void draw(final boolean _disableDepthTest) { @@ -230,7 +230,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief draw All the refistered text in the current element on openGL + * draw All the refistered text in the current element on openGL */ public abstract void drawD(final boolean _disableDepthTest);; @@ -238,13 +238,13 @@ public abstract class TextBase extends Compositing { public abstract void drawMT(final Matrix4f _transformationMatrix, final boolean _enableDepthTest); /** - * @brief calculate the element number that is the first out the alignement + * calculate the element number that is the first out the alignement * range (start at the specify ID, and use start pos with current one) - * @param[in] _text The string that might be parsed. - * @param[in] _start The first elemnt that might be used to calculate. - * @param[out] _stop The last Id availlable in the current string. - * @param[out] _space Number of space in the string. - * @param[out] _freespace This represent the number of pixel present in the + * @param _text The string that might be parsed. + * @param _start The first elemnt that might be used to calculate. + * @param _stop The last Id availlable in the current string. + * @param _space Number of space in the string. + * @param _freespace This represent the number of pixel present in the * right white space. * @return true if the rifht has free space that can be use for jystify. * @return false if we find '\n' @@ -308,7 +308,7 @@ public abstract class TextBase extends Compositing { }; /** - * @brief This generate the line return == > it return to the alignement + * This generate the line return == > it return to the alignement * position start and at the correct line position ==> it might be use to * not know the line height */ @@ -318,7 +318,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief get the current alignement property + * get the current alignement property * @return the curent alignement type */ public AligneMode getAlignement() { @@ -326,7 +326,7 @@ public abstract class TextBase extends Compositing { }; /** - * @brief get the current font mode + * get the current font mode * @return The font mode applied */ public FontMode getFontMode() { @@ -338,7 +338,7 @@ public abstract class TextBase extends Compositing { public abstract float getHeight();; /** - * @brief get the current display position (sometime needed in the gui control) + * get the current display position (sometime needed in the gui control) * @return the current position. */ public Vector3f getPos() { @@ -348,8 +348,8 @@ public abstract class TextBase extends Compositing { public abstract float getSize(); /** - * @brief add a line with the current this.htmlDecoTmp decoration - * @param[in] _data The cuurent data to add. + * add a line with the current this.htmlDecoTmp decoration + * @param _data The cuurent data to add. */ public void htmlAddData(final String _data) { if (this.htmlCurrrentLine.length() > 0 @@ -369,7 +369,7 @@ public abstract class TextBase extends Compositing { }; /** - * @brief draw the current line + * draw the current line */ public void htmlFlush() { if (this.htmlCurrrentLine.length() > 0) { @@ -380,7 +380,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief load the openGL program and get all the ID needed + * load the openGL program and get all the ID needed */ public void loadProgram(final Uri _vertexShader, final Uri _fragmentShader) { ResourceProgram old = this.GLprogram; @@ -401,9 +401,9 @@ public abstract class TextBase extends Compositing { }; /** - * @brief This parse a tinyXML node (void pointer to permit to hide tiny XML in + * This parse a tinyXML node (void pointer to permit to hide tiny XML in * include). - * @param[in] _element the exml element. + * @param _element the exml element. */ public void parseHtmlNode(final XmlElement _element) { for (XmlNode it : _element.getNodes()) { @@ -514,8 +514,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief display a compleat string in the current element. - * @param[in] _text The string to display. + * display a compleat string in the current element. + * @param _text The string to display. */ public void print(final String _text) { List decorationEmpty = new ArrayList<>(); @@ -523,10 +523,10 @@ public abstract class TextBase extends Compositing { } /** - * @brief display a compleat string in the current element whith specific + * display a compleat string in the current element whith specific * decorations (advence mode). - * @param[in] _text The string to display. - * @param[in] _decoration The text decoration for the text that might be display + * @param _text The string to display. + * @param _decoration The text decoration for the text that might be display * (if the vector is smaller, the last parameter is get) */ public void print(final String _text, final List _decoration) { @@ -705,16 +705,16 @@ public abstract class TextBase extends Compositing { } /** - * @brief display the current char in the current element (note that the kerning + * display the current char in the current element (note that the kerning * is availlable if the position is not changed) - * @param[in] _charcode Char that might be dispalyed + * @param _charcode Char that might be dispalyed */ public abstract void printChar(Character _charcode); /** - * @brief draw a cursor at the specify position - * @param[in] _isInsertMode True if the insert mode is activated - * @param[in] _cursorSize The sizae of the cursor that might be set when insert + * draw a cursor at the specify position + * @param _isInsertMode True if the insert mode is activated + * @param _cursorSize The sizae of the cursor that might be set when insert * mode is set [default 20] */ public void printCursor(final boolean _isInsertMode) { @@ -733,7 +733,7 @@ public abstract class TextBase extends Compositing { }; /** - * @brief display a compleat string in the current element with the generic + * display a compleat string in the current element with the generic * decoration specification. (basic html data) * * [code style=xml]
@@ -757,7 +757,7 @@ public abstract class TextBase extends Compositing { * * @note This is parsed with tiny xml, then be carfull that the XML is correct, * and all balises are closed ... otherwite the display can not be done - * @param[in] _text The string to display. + * @param _text The string to display. * @TODO : implementation not done .... */ public void printDecorated(final String _text) { @@ -769,7 +769,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief display a compleat string in the current element with the generic + * display a compleat string in the current element with the generic * decoration specification. (basic html data) * * [code style=xml]
@@ -793,7 +793,7 @@ public abstract class TextBase extends Compositing { * * @note This is parsed with tiny xml, then be carfull that the XML is correct, * and all balises are closed ... otherwite the display can not be done - * @param[in] _text The string to display. + * @param _text The string to display. * @TODO : implementation not done .... */ public void printHTML(final String _text) { @@ -828,7 +828,7 @@ public abstract class TextBase extends Compositing { } /** - * @brief clear all the intermediate result detween 2 prints + * clear all the intermediate result detween 2 prints */ public void reset() { this.position = Vector3f.ZERO; @@ -871,9 +871,9 @@ public abstract class TextBase extends Compositing { } /** - * @brief Request a clipping area for the text (next draw only) - * @param[in] _pos Start position of the clipping - * @param[in] _posEnd End position of the clipping + * Request a clipping area for the text (next draw only) + * @param _pos Start position of the clipping + * @param _posEnd End position of the clipping */ public void setClipping(final Vector3f _pos, final Vector3f _posEnd) { // note the internal system all time request to have a bounding all time in the @@ -886,9 +886,9 @@ public abstract class TextBase extends Compositing { } /** - * @brief enable/Disable the clipping (without lose the current clipping + * enable/Disable the clipping (without lose the current clipping * position) - * @brief _newMode The new status of the clipping + * _newMode The new status of the clipping */ // TODO : Rename setClippingActivity public void setClippingMode(final boolean _newMode) { @@ -902,26 +902,26 @@ public abstract class TextBase extends Compositing { } /** - * @brief Request a clipping area for the text (next draw only) - * @param[in] _pos Start position of the clipping - * @param[in] _width Width size of the clipping + * Request a clipping area for the text (next draw only) + * @param _pos Start position of the clipping + * @param _width Width size of the clipping */ public void setClippingWidth(final Vector3f _pos, final Vector3f _width) { setClipping(_pos, _pos.add(_width)); } /** - * @brief set the Color of the current foreground font - * @param[in] _color Color to set on foreground (for next print) + * set the Color of the current foreground font + * @param _color Color to set on foreground (for next print) */ public void setColor(final Color _color) { this.color = _color; } /** - * @brief set the background color of the font (for selected Text (not the + * set the background color of the font (for selected Text (not the * global BG)) - * @param[in] _color Color to set on background (for next print) + * @param _color Color to set on background (for next print) */ public void setColorBg(final Color _color) { this.colorBg = _color; @@ -929,16 +929,16 @@ public abstract class TextBase extends Compositing { } /** - * @brief change the cursor color - * @param[in] _color New color for the Selection + * change the cursor color + * @param _color New color for the Selection */ public void setCursorColor(final Color _color) { this.colorCursor = _color; } /** - * @brief set a cursor at a specific position: - * @param[in] _cursorPos id of the cursor position + * set a cursor at a specific position: + * @param _cursorPos id of the cursor position */ public void setCursorPos(final int _cursorPos) { this.selectionStartPos = _cursorPos; @@ -946,9 +946,9 @@ public abstract class TextBase extends Compositing { } /** - * @brief set a cursor at a specific position with his associated selection: - * @param[in] _cursorPos id of the cursor position - * @param[in] _selectionStartPos id of the starting of the selection + * set a cursor at a specific position with his associated selection: + * @param _cursorPos id of the cursor position + * @param _selectionStartPos id of the starting of the selection */ public void setCursorSelection(final int _cursorPos, final int _selectionStartPos) { this.selectionStartPos = _selectionStartPos; @@ -956,34 +956,34 @@ public abstract class TextBase extends Compositing { } /** - * @brief set the default background color of the font (when reset, set this + * set the default background color of the font (when reset, set this * value ...) - * @param[in] _color Color to set on background + * @param _color Color to set on background */ public void setDefaultColorBg(final Color _color) { this.defaultColorBg = _color; } /** - * @brief set the default Foreground color of the font (when reset, set this + * set the default Foreground color of the font (when reset, set this * value ...) - * @param[in] _color Color to set on foreground + * @param _color Color to set on foreground */ public void setDefaultColorFg(final Color _color) { this.defaultColorFg = _color; } /** - * @brief Specify the font property (this reset the internal element of the + * Specify the font property (this reset the internal element of the * current text (system requirement) - * @param[in] fontName Current name of the selected font - * @param[in] fontSize New font size + * @param fontName Current name of the selected font + * @param fontSize New font size */ public abstract void setFont(final String _fontName, final int _fontSize); /** - * @brief enable or disable the bold mode - * @param[in] _status The new status for this display property + * enable or disable the bold mode + * @param _status The new status for this display property */ public void setFontBold(final boolean _status) { if (_status == true) { @@ -1004,8 +1004,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief enable or disable the italic mode - * @param[in] _status The new status for this display property + * enable or disable the italic mode + * @param _status The new status for this display property */ public void setFontItalic(final boolean _status) { if (_status == true) { @@ -1026,28 +1026,28 @@ public abstract class TextBase extends Compositing { } /** - * @brief Specify the font mode for the next @ref print - * @param[in] mode The font mode requested + * Specify the font mode for the next @ref print + * @param mode The font mode requested */ public abstract void setFontMode(FontMode _mode);; /** - * @brief Specify the font name (this reset the internal element of the current + * Specify the font name (this reset the internal element of the current * text (system requirement) - * @param[in] _fontName Current name of the selected font + * @param _fontName Current name of the selected font */ public abstract void setFontName(final String _fontName); /** - * @brief Specify the font size (this reset the internal element of the current + * Specify the font size (this reset the internal element of the current * text (system requirement) - * @param[in] _fontSize New font size + * @param _fontSize New font size */ public abstract void setFontSize(final int _fontSize); /** - * @brief set the activation of the Kerning for the display (if it existed) - * @param[in] _newMode enable/Diasable the kerning on this font. + * set the activation of the Kerning for the display (if it existed) + * @param _newMode enable/Diasable the kerning on this font. */ public void setKerningMode(final boolean _newMode) { this.kerning = _newMode; @@ -1059,8 +1059,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief set position for the next text writen - * @param[in] _pos Position of the text (in 3D) + * set position for the next text writen + * @param _pos Position of the text (in 3D) */ public void setPos(final Vector3f _pos) { // check min max for display area @@ -1091,8 +1091,8 @@ public abstract class TextBase extends Compositing { } /** - * @brief set relative position for the next text written - * @param[in] _pos offset apply of the text (in 3D) + * set relative position for the next text written + * @param _pos offset apply of the text (in 3D) */ public void setRelPos(final Vector3f _pos) { this.position = this.position.add(_pos); @@ -1101,18 +1101,18 @@ public abstract class TextBase extends Compositing { } /** - * @brief change the selection color - * @param[in] _color New color for the Selection + * change the selection color + * @param _color New color for the Selection */ public void setSelectionColor(final Color _color) { this.colorSelection = _color; } /** - * @brief This generate the possibility to generate the big text property - * @param[in] _startTextpos The x text start position of the display. - * @param[in] _stopTextPos The x text stop position of the display. - * @param[in] _alignement mode of alignement for the Text. + * This generate the possibility to generate the big text property + * @param _startTextpos The x text start position of the display. + * @param _stopTextPos The x text stop position of the display. + * @param _alignement mode of alignement for the Text. * @note The text align in center change of line every display done (even if it * was just a char) */ diff --git a/src/org/atriasoft/ewol/context/ConfigFont.java b/src/org/atriasoft/ewol/context/ConfigFont.java index 7d40638..9dd8303 100644 --- a/src/org/atriasoft/ewol/context/ConfigFont.java +++ b/src/org/atriasoft/ewol/context/ConfigFont.java @@ -21,7 +21,7 @@ public class ConfigFont { public ConfigFont() {} /** - * @brief get the default font folder. + * get the default font folder. * @return The default font folder. */ public Uri getFolder() { @@ -29,7 +29,7 @@ public class ConfigFont { } /** - * @brief get the current default font name + * get the current default font name * @return a reference on the font name string */ public String getName() { @@ -37,7 +37,7 @@ public class ConfigFont { } /** - * @brief get the default font size. + * get the default font size. * @return the font size. */ public int getSize() { @@ -45,7 +45,7 @@ public class ConfigFont { }; /** - * @brief get the use of internal/external Font + * get the use of internal/external Font * @return true to enable search of internal data. */ public boolean getUseExternal() { @@ -53,9 +53,9 @@ public class ConfigFont { } /** - * @brief set the defaut font for all the widgets and basics display. - * @param[in] _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". - * @param[in] _size The default size of the font default=10. + * set the defaut font for all the widgets and basics display. + * @param _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". + * @param _size The default size of the font default=10. */ public void set(final String _fontName, final int _size) { this.name = _fontName; @@ -64,16 +64,16 @@ public class ConfigFont { }; /** - * @brief Specify the default font folder for the Ewol search system (only needed when embended font) - * @param[in] _folder basic folder of the font (ex: DATA:fonts) + * Specify the default font folder for the Ewol search system (only needed when embended font) + * @param _folder basic folder of the font (ex: DATA:fonts) */ public void setFolder(final Uri _folder) { this.folder = _folder; } /** - * @brief Set the current default font name - * @param[in] _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". + * Set the current default font name + * @param _fontName The font name requested (not case sensitive) ex "Arial" or multiple separate by ';' ex : "Arial;Helvetica". */ public void setName(final String _fontName) { this.name = _fontName; @@ -81,8 +81,8 @@ public class ConfigFont { } /** - * @brief Set the default font size. - * @param[in] _size new font size. + * Set the default font size. + * @param _size new font size. */ public void setSize(final int _size) { this.size = _size; @@ -90,8 +90,8 @@ public class ConfigFont { }; /** - * @brief set use of internal/external Font - * @param[in] _val true to enable search of internal data. + * set use of internal/external Font + * @param _val true to enable search of internal data. */ public void setUseExternal(final boolean _val) { this.useExternal = _val; diff --git a/src/org/atriasoft/ewol/context/EwolApplication.java b/src/org/atriasoft/ewol/context/EwolApplication.java index db923af..4b96ffb 100644 --- a/src/org/atriasoft/ewol/context/EwolApplication.java +++ b/src/org/atriasoft/ewol/context/EwolApplication.java @@ -8,46 +8,46 @@ package org.atriasoft.ewol.context; public interface EwolApplication { /** - * @brief The application is created. - * @param[in] _context Current ewol context. + * The application is created. + * @param _context Current ewol context. */ void onCreate(EwolContext _context); /** - * @brief The application is removed (call destructor just adter it.). - * @param[in] _context Current ewol context. + * The application is removed (call destructor just adter it.). + * @param _context Current ewol context. */ void onDestroy(EwolContext _context); /** - * @brief The user request application removing. - * @param[in] _context Current ewol context. + * The user request application removing. + * @param _context Current ewol context. */ default void onKillDemand(final EwolContext _context) { _context.exit(0); } /** - * @brief The application is Hide / not visible. - * @param[in] _context Current ewol context. + * The application is Hide / not visible. + * @param _context Current ewol context. */ void onPause(EwolContext _context); /** - * @brief The application is resumed (now visible). - * @param[in] _context Current ewol context. + * The application is resumed (now visible). + * @param _context Current ewol context. */ void onResume(EwolContext _context); /** - * @brief The application is started. - * @param[in] _context Current ewol context. + * The application is started. + * @param _context Current ewol context. */ void onStart(EwolContext _context); /** - * @brief The application is stopped. - * @param[in] _context Current ewol context. + * The application is stopped. + * @param _context Current ewol context. */ void onStop(EwolContext _context); } \ No newline at end of file diff --git a/src/org/atriasoft/ewol/context/EwolContext.java b/src/org/atriasoft/ewol/context/EwolContext.java index 0a325b9..546038c 100644 --- a/src/org/atriasoft/ewol/context/EwolContext.java +++ b/src/org/atriasoft/ewol/context/EwolContext.java @@ -32,7 +32,7 @@ public abstract class EwolContext extends Application { private static EwolContext curentInterface = null; /** - * @brief From everyware in the program, we can get the context inteface. + * From everyware in the program, we can get the context inteface. * @return current reference on the instance. */ public static EwolContext getContext() { @@ -40,15 +40,15 @@ public abstract class EwolContext extends Application { } /** - * @brief This is the only one things the User might done in his main(); + * This is the only one things the User might done in his main(); * @note : must be implemented in all system OPS implementation * @note To answare you before you ask the question, this is really simple: Due * to the fect that the current system is multiple-platform, you "main" * Does not exist in the android platform, then ewol call other start and * stop function, to permit to have only one code * @note The main can not be in the ewol, due to the fact thet is an librairy - * @param[in] _argc Standard argc - * @param[in] _argv Standard argv + * @param _argc Standard argc + * @param _argv Standard argv * @return normal error int for the application error management */ public static int main(String[] _args); @@ -79,7 +79,7 @@ public abstract class EwolContext extends Application { } /** - * @brief Redraw all the windows + * Redraw all the windows */ public void forceRedrawAll() { if (this.windowsCurrent == null) { @@ -115,7 +115,7 @@ public abstract class EwolContext extends Application { } /** - * @brief get the current windows that is displayed + * get the current windows that is displayed * @return the current handle on the windows (can be null) */ public Windows getWindows() { @@ -123,16 +123,16 @@ public abstract class EwolContext extends Application { } /** - * @brief This fonction lock the pointer properties to move in relative instead + * This fonction lock the pointer properties to move in relative instead * of absolute - * @param[in] widget The widget that lock the pointer events + * @param widget The widget that lock the pointer events */ public void inputEventGrabPointer(final Widget _widget) { this.input.grabPointer(_widget); } /** - * @brief This is to transfert the event from one widget to another one + * This is to transfert the event from one widget to another one * @param source the widget where the event came from * @param destination the widget where the event mitgh be generated now */ @@ -141,7 +141,7 @@ public abstract class EwolContext extends Application { } /** - * @brief This fonction un-lock the pointer properties to move in relative + * This fonction un-lock the pointer properties to move in relative * instead of absolute */ public void inputEventUnGrabPointer() { @@ -391,7 +391,7 @@ public abstract class EwolContext extends Application { } /** - * @brief Request a display after call a resize + * Request a display after call a resize */ public void requestUpdateSize() { final Context context = Gale.getContext(); @@ -399,22 +399,22 @@ public abstract class EwolContext extends Application { } /** - * @brief reset event management for the IO like Input ou Mouse or keyborad + * reset event management for the IO like Input ou Mouse or keyborad */ public void resetIOEvent() { this.input.newLayerSet(); } /** - * @brief Special for init (main) set the start image when loading data - * @param[in] _fileName Name of the image to load + * Special for init (main) set the start image when loading data + * @param _fileName Name of the image to load */ public void setInitImage(final Uri _fileName) { // this.initDisplayImageName = _fileName; } /** - * @brief set the current windows to display : + * set the current windows to display : * @param _windows Windows that might be displayed */ public void setWindows(final Windows _windows) { diff --git a/src/org/atriasoft/ewol/context/InputManager.java b/src/org/atriasoft/ewol/context/InputManager.java index e57e330..9529690 100644 --- a/src/org/atriasoft/ewol/context/InputManager.java +++ b/src/org/atriasoft/ewol/context/InputManager.java @@ -20,7 +20,7 @@ import org.atriasoft.gale.key.KeyStatus; import org.atriasoft.gale.key.KeyType; /** - * @brief internal structure + * internal structure */ class InputLimit { public Duration sepatateTime; @@ -88,8 +88,8 @@ class InputManager { } /** - * @brief This fonction lock the pointer properties to move in relative instead of absolute - * @param[in] _widget The widget that lock the pointer events + * This fonction lock the pointer properties to move in relative instead of absolute + * @param _widget The widget that lock the pointer events */ public void grabPointer(final Widget _widget) { if (_widget == null) { @@ -104,12 +104,12 @@ class InputManager { } /** - * @brief generate the event on the destinated widget. - * @param[in] _type Type of the event that might be sended. - * @param[in] _destWidget Pointer on the requested widget that element might be sended - * @param[in] _IdInput Id of the event (PC : [0..9] and touch : [1..9]) - * @param[in] _typeEvent type of the eventg generated - * @param[in] _pos position of the event + * generate the event on the destinated widget. + * @param _type Type of the event that might be sended. + * @param _destWidget Pointer on the requested widget that element might be sended + * @param _IdInput Id of the event (PC : [0..9] and touch : [1..9]) + * @param _typeEvent type of the eventg generated + * @param _pos position of the event * @return true if event has been greped */ public boolean localEventInput(final KeyType _type, final Widget _destWidget, final int _IdInput, final KeyStatus _status, final Vector2f _pos) { @@ -128,12 +128,12 @@ class InputManager { } /** - * @brief convert the system event id in the correct EWOL id depending of the system management mode + * convert the system event id in the correct EWOL id depending of the system management mode * This function find the next input id unused on the specifiic widget * == > on PC, the ID does not change (GUI is not the same) - * @param[in] _type Type of the kay event. - * @param[in] _destWidget Pointer of the widget destination - * @param[in] _realInputId system Id + * @param _type Type of the kay event. + * @param _destWidget Pointer of the widget destination + * @param _realInputId system Id * @return the ewol input id */ public int localGetDestinationId(final KeyType _type, final Widget _destWidget, final int _realInputId) { @@ -236,7 +236,7 @@ class InputManager { } /** - * @brief a new layer on the windows is set == > might remove all the property of the current element ... + * a new layer on the windows is set == > might remove all the property of the current element ... */ public void newLayerSet() { for (int iii = 0; iii < MAX_MANAGE_INPUT; iii++) { @@ -404,7 +404,7 @@ class InputManager { } /** - * @brief This is to transfert the event from one widget to another one + * This is to transfert the event from one widget to another one * @param _source the widget where the event came from * @param _destination the widget where the event mitgh be generated now */ @@ -440,7 +440,7 @@ class InputManager { } /** - * @brief This function un-lock the pointer properties to move in relative instead of absolute + * This function un-lock the pointer properties to move in relative instead of absolute */ public void unGrabPointer() { this.grabWidget = null; @@ -450,7 +450,7 @@ class InputManager { }; /** - * @brief internal structure + * internal structure */ class InputPoperty { public boolean isUsed; diff --git a/src/org/atriasoft/ewol/event/EventInput.java b/src/org/atriasoft/ewol/event/EventInput.java index a7e954c..d18816a 100644 --- a/src/org/atriasoft/ewol/event/EventInput.java +++ b/src/org/atriasoft/ewol/event/EventInput.java @@ -48,7 +48,7 @@ public class EventInput { }; /** - * @brief Reset the input property of the curent event. + * Reset the input property of the curent event. */ public void reset() { // TODO : Call the entry element ant rest it ... diff --git a/src/org/atriasoft/ewol/internal/Tools.java b/src/org/atriasoft/ewol/internal/Tools.java index 8170e7f..b706c0c 100644 --- a/src/org/atriasoft/ewol/internal/Tools.java +++ b/src/org/atriasoft/ewol/internal/Tools.java @@ -2,8 +2,8 @@ package org.atriasoft.ewol.internal; public class Tools { /** - * @brief get the next power 2 if the input - * @param[in] value Value that we want the next power of 2 + * get the next power 2 if the input + * @param value Value that we want the next power of 2 * @return result value */ public static int nextP2(final int _value) { diff --git a/src/org/atriasoft/ewol/object/EwolObject.java b/src/org/atriasoft/ewol/object/EwolObject.java index 013ea9a..50beca6 100644 --- a/src/org/atriasoft/ewol/object/EwolObject.java +++ b/src/org/atriasoft/ewol/object/EwolObject.java @@ -14,14 +14,14 @@ import org.atriasoft.exml.model.XmlElement; */ /** - * @brief Basic message classes for ewol system + * Basic message classes for ewol system * this class permit at every Object to communicate between them. */ public class EwolObject { private static Integer valUID = 0; //!< Static used for the unique ID definition /** - * @brief get the curent the system inteface. + * get the curent the system inteface. * @return current reference on the instance. */ protected static EwolContext getContext() { @@ -37,8 +37,8 @@ public class EwolObject { } /** - * @brief Retrive an object with his name (in the global list) - * @param[in] _name Name of the object + * Retrive an object with his name (in the global list) + * @param _name Name of the object * @return the requested object or null */ public static EwolObject getObjectNamed(final String _objectName) { @@ -60,7 +60,7 @@ public class EwolObject { private boolean isResource = false; //!< enable this when you want to declare this element is auto-remove /** - * @brief Constructor. + * Constructor. */ public EwolObject() { // note this is nearly atomic ... (but it is enough) @@ -73,7 +73,7 @@ public class EwolObject { } /** - * @brief Auto-destroy the object + * Auto-destroy the object */ protected void autoDestroy() { Log.verbose("Destroy object: [" + getId() + "] type:" + this.getClass().getCanonicalName()); @@ -89,14 +89,14 @@ public class EwolObject { } /** - * @brief Destroy the current object + * Destroy the current object */ public void destroy() { autoDestroy(); }; /** - * @brief get the UniqueId of the Object + * get the UniqueId of the Object * @return the requested ID */ public int getId() { @@ -108,8 +108,8 @@ public class EwolObject { }; /** - * @brief load attribute properties with an XML node. - * @param[in] _node Reference on the XML node. + * load attribute properties with an XML node. + * @param _node Reference on the XML node. * @return true : All has been done corectly. * @return false : An error occured. */ @@ -134,8 +134,8 @@ public class EwolObject { */ /** - * @brief load properties with an XML node. - * @param[in] _node Reference on the XML node. + * load properties with an XML node. + * @param _node Reference on the XML node. * @return true : All has been done corectly. * @return false : An error occured. */ @@ -144,7 +144,7 @@ public class EwolObject { } /** - * @brief store properties in this XML node. + * store properties in this XML node. * @param[in,out] _node Reference on the XML node. * @return true : All has been done corectly. * @return false : An error occured. @@ -163,7 +163,7 @@ public class EwolObject { */ /** - * @brief get the static status of the Object == > mark at true if the user set the object mark as static allocated element ==> not auto remove element + * get the static status of the Object == > mark at true if the user set the object mark as static allocated element ==> not auto remove element * @return true if it might not be removed == > usefull for conficuration class */ public boolean getStatic() { @@ -171,7 +171,7 @@ public class EwolObject { } /** - * @brief Get the resource status of the element. + * Get the resource status of the element. * @return the resource status. */ public boolean getStatusResource() { @@ -179,8 +179,8 @@ public class EwolObject { } /** - * @brief Retrive an object with his name (in the global list) - * @param[in] _name Name of the object + * Retrive an object with his name (in the global list) + * @param _name Name of the object * @return the requested object or null */ public EwolObject getSubObjectNamed(final String _objectName) { @@ -192,7 +192,7 @@ public class EwolObject { } /** - * @brief Check if the current objetc his destroy (in removing) + * Check if the current objetc his destroy (in removing) * @return true The object is removed * @return false The object is not removed */ @@ -201,15 +201,15 @@ public class EwolObject { } /** - * @brief Remove the current parenting. + * Remove the current parenting. */ public void removeParent() { this.parent = null; } /** - * @brief Called by a whild that want to remove pointer of itself from the current list of his parrent - * @param[in] _child Object of the child that want to remove itself + * Called by a whild that want to remove pointer of itself from the current list of his parrent + * @param _child Object of the child that want to remove itself */ protected void requestDestroyFromChild(final EwolObject _child) { Log.info("requestDestroyFromChild(...) is called when an object reference as a parent have a child that request quto-destroy ..."); @@ -221,8 +221,8 @@ public class EwolObject { } /** - * @brief Set the Object has new parrent. - * @param[in] _newParent Object that requesting the parenting + * Set the Object has new parrent. + * @param _newParent Object that requesting the parenting */ public void setParent(final EwolObject _newParent) { // TODO : Implement change of parent ... @@ -230,9 +230,9 @@ public class EwolObject { } /** - * @brief Declare this element as a resource (or singleton) this mean the element will + * Declare this element as a resource (or singleton) this mean the element will * not be auto Remove at the end of the programm. It just notify that it is not removed. - * @param[in] _val Value of the type of the element. + * @param _val Value of the type of the element. */ public void setStatusResource(final boolean _val) { this.isResource = _val; diff --git a/src/org/atriasoft/ewol/object/ObjectManager.java b/src/org/atriasoft/ewol/object/ObjectManager.java index 29d7c75..589db19 100644 --- a/src/org/atriasoft/ewol/object/ObjectManager.java +++ b/src/org/atriasoft/ewol/object/ObjectManager.java @@ -43,9 +43,9 @@ public class ObjectManager { } /** - * @brief Internal API that used only with Object toi reference itself in the manager. + * Internal API that used only with Object toi reference itself in the manager. * @note The manager remove the object when the refecence Low down 1 (last keeper) - * @param[in] _object Reference shared pointer on the object + * @param _object Reference shared pointer on the object */ public synchronized void add(final EwolObject _object) { if (_object == null) { @@ -55,7 +55,7 @@ public class ObjectManager { } /** - * @brief clean the weak pointer list (remove weak_ptr that is remoed) + * clean the weak pointer list (remove weak_ptr that is remoed) */ public synchronized void cleanInternalRemoved() { final int nbObject = this.eObjectList.size(); @@ -73,7 +73,7 @@ public class ObjectManager { } /** - * @brief Display all object Open. + * Display all object Open. */ public synchronized void displayListObject() { Log.info("List loaded object : "); @@ -86,8 +86,8 @@ public class ObjectManager { } /** - * @brief Retrive an Object with his name - * @param[in] _name Name of the Object + * Retrive an Object with his name + * @param _name Name of the Object * @return Pointer on the finded Object. */ public synchronized EwolObject get(final String _name) { @@ -104,7 +104,7 @@ public class ObjectManager { } /** - * @brief Get the number of loaded object in the system + * Get the number of loaded object in the system * @return number of Object */ public synchronized int getNumberObject() { @@ -112,8 +112,8 @@ public class ObjectManager { } /** - * @brief retrive an object with his name - * @param[in] _name Name of the object + * retrive an object with his name + * @param _name Name of the object * @return the requested object or null */ public synchronized EwolObject getObjectNamed(final String _name) { @@ -121,8 +121,8 @@ public class ObjectManager { } /** - * @brief Call every time we can with the current time - * @param[in] _localTime Current system Time. + * Call every time we can with the current time + * @param _localTime Current system Time. */ public synchronized void timeCall(final Clock _localTime) { final Clock previousTime = this.lastPeriodicCallTime; @@ -145,15 +145,15 @@ public class ObjectManager { } /** - * @brief If the application is suspended The Ewol Object manager does not know it, just call this to update delta call - * @param[in] _localTime Current system Time. + * If the application is suspended The Ewol Object manager does not know it, just call this to update delta call + * @param _localTime Current system Time. */ public synchronized void timeCallResume(final Clock _localTime) { this.lastPeriodicCallTime = _localTime; } /** - * @brief remove all resources (un-init) out of the destructor (due to the system implementation) + * remove all resources (un-init) out of the destructor (due to the system implementation) */ public synchronized void unInit() { Log.debug(" == > Un-Init Object-Manager"); @@ -174,16 +174,16 @@ public class ObjectManager { } /** - * @brief Add a worker on the system list. - * @param[in] _worker Worker to add in the list. + * Add a worker on the system list. + * @param _worker Worker to add in the list. */ public synchronized void workerAdd(final EwolObject _worker) { this.workerList.add(_worker); } /** - * @brief Remove a worker on the system list. - * @param[in] _worker Worker to add in the list. + * Remove a worker on the system list. + * @param _worker Worker to add in the list. */ public synchronized void workerRemove(final EwolObject _worker) { diff --git a/src/org/atriasoft/ewol/object/Worker.java b/src/org/atriasoft/ewol/object/Worker.java index 0e581aa..c80eac7 100644 --- a/src/org/atriasoft/ewol/object/Worker.java +++ b/src/org/atriasoft/ewol/object/Worker.java @@ -7,11 +7,11 @@ package org.atriasoft.ewol.object; */ /** - * @brief A worker might not been possesed by someone, then the system might keep a pointer on it. + * A worker might not been possesed by someone, then the system might keep a pointer on it. */ public class Worker extends EwolObject { /** - * @brief Constructor. + * Constructor. */ public Worker() { getObjectManager().workerAdd(this); diff --git a/src/org/atriasoft/ewol/resource/RefactorColored3DObject.java b/src/org/atriasoft/ewol/resource/RefactorColored3DObject.java index de2dab8..1867f2e 100644 --- a/src/org/atriasoft/ewol/resource/RefactorColored3DObject.java +++ b/src/org/atriasoft/ewol/resource/RefactorColored3DObject.java @@ -18,7 +18,7 @@ import org.atriasoft.gale.resource.Resource; import org.atriasoft.gale.resource.ResourceProgram; /** - * @brief simple display of Colored3DObject ==> for DEBUG only Not availlable on + * simple display of Colored3DObject ==> for DEBUG only Not availlable on * ALL platform (like webGL) */ public class RefactorColored3DObject extends Resource { diff --git a/src/org/atriasoft/ewol/resource/ResourceColorFile.java b/src/org/atriasoft/ewol/resource/ResourceColorFile.java index 5001972..000c56c 100644 --- a/src/org/atriasoft/ewol/resource/ResourceColorFile.java +++ b/src/org/atriasoft/ewol/resource/ResourceColorFile.java @@ -30,7 +30,7 @@ class ListElement { } /** - * @brief ColorFile is a Resource designed to be specific with the theme (for + * ColorFile is a Resource designed to be specific with the theme (for * example black, or white or orange ...) */ public class ResourceColorFile extends Resource { @@ -38,8 +38,8 @@ public class ResourceColorFile extends Resource { private Color errorColor = Color.ORANGE; /** - * @brief Constructor of the color property file - * @param[in] _uri Name of the file needed + * Constructor of the color property file + * @param _uri Name of the file needed */ public ResourceColorFile(final Uri _uri) { super(_uri.get()); @@ -54,8 +54,8 @@ public class ResourceColorFile extends Resource { } /** - * @brief Get the associated color of the ID. - * @param[in] _Id Id of the color. + * Get the associated color of the ID. + * @param _Id Id of the color. * @return The requested color. */ Color get(final int _id) { @@ -66,7 +66,7 @@ public class ResourceColorFile extends Resource { } /** - * @brief Get All color name + * Get All color name * @return list of all color existing */ List getColors() { @@ -138,8 +138,8 @@ public class ResourceColorFile extends Resource { } /** - * @brief Request the presence of a specific color. - * @param[in] _paramName Name of the color. + * Request the presence of a specific color. + * @param _paramName Name of the color. * @return A unique ID of the color (or -1 if an error occured). */ public synchronized int request(final String _paramName) { @@ -154,8 +154,8 @@ public class ResourceColorFile extends Resource { } /** - * @brief Set the error color. - * @param[in] _errorColor Color that might be set when not finding a color + * Set the error color. + * @param _errorColor Color that might be set when not finding a color */ public void setErrorColor(final Color _errorColor) { this.errorColor = _errorColor; diff --git a/src/org/atriasoft/ewol/resource/ResourceConfigFile.java b/src/org/atriasoft/ewol/resource/ResourceConfigFile.java index 8d3605d..2ac3262 100644 --- a/src/org/atriasoft/ewol/resource/ResourceConfigFile.java +++ b/src/org/atriasoft/ewol/resource/ResourceConfigFile.java @@ -17,9 +17,9 @@ import org.atriasoft.gale.resource.Resource; public class ResourceConfigFile extends Resource { /** - * @brief keep the resource pointer. + * keep the resource pointer. * @note Never free this pointer by your own... - * @param[in] _filename Name of the configuration file. + * @param _filename Name of the configuration file. * @return pointer on the resource or null if an error occured. */ public static ResourceConfigFile keep(final String name) { diff --git a/src/org/atriasoft/ewol/resource/ResourceTexture2.java b/src/org/atriasoft/ewol/resource/ResourceTexture2.java index 5cab712..ece05be 100644 --- a/src/org/atriasoft/ewol/resource/ResourceTexture2.java +++ b/src/org/atriasoft/ewol/resource/ResourceTexture2.java @@ -52,7 +52,7 @@ public class ResourceTexture2 extends Resource { */ /** - * @brief get the next power 2 if the input + * get the next power 2 if the input * @param value Value that we want the next power of 2 * @return result value */ @@ -168,9 +168,9 @@ public class ResourceTexture2 extends Resource { }; /** - * @brief Set the image in the texture system + * Set the image in the texture system * @note It will resize in square2 if needed by the system. - * @param[in] _image Image to set. + * @param _image Image to set. */ public synchronized void set(final Image _image) { Log.debug("Set a new image in a texture:"); @@ -187,9 +187,9 @@ public class ResourceTexture2 extends Resource { }; /** - * @brief Set the Filter mode to apply at the image when display with a scale + * Set the Filter mode to apply at the image when display with a scale * (not 1:1 ratio) - * @param[in] _value Value of the new filter mode + * @param _value Value of the new filter mode */ public void setFilterMode(final TextureFilter _filter) { this.filter = _filter; @@ -202,8 +202,8 @@ public class ResourceTexture2 extends Resource { }; /** - * @brief Set the repeate mode of the images if UV range is out of [0..1] - * @param[in] _value Value of the new repeate mode + * Set the repeate mode of the images if UV range is out of [0..1] + * @param _value Value of the new repeate mode */ public void setRepeat(final boolean _value) { this.repeat = _value; diff --git a/src/org/atriasoft/ewol/resource/ResourceTextureFile.java b/src/org/atriasoft/ewol/resource/ResourceTextureFile.java index d92e28a..d1d0189 100644 --- a/src/org/atriasoft/ewol/resource/ResourceTextureFile.java +++ b/src/org/atriasoft/ewol/resource/ResourceTextureFile.java @@ -19,12 +19,12 @@ public class ResourceTextureFile extends ResourceTexture2 { public static Vector2i sizeDefault = new Vector2i(0, 0); /** - * @brief keep the resource pointer. + * keep the resource pointer. * @note Never free this pointer by your own... - * @param[in] _filename Name of the image file. - * @param[in] _requested size of the image (usefull when loading .svg to + * @param _filename Name of the image file. + * @param _requested size of the image (usefull when loading .svg to * automatic rescale) - * @param[in] _sizeRegister size register in named (When you preaload the images + * @param _sizeRegister size register in named (When you preaload the images * the size write here will be ) * @return pointer on the resource or null if an error occured. */ diff --git a/src/org/atriasoft/ewol/resource/ResourceTexturedFont.java b/src/org/atriasoft/ewol/resource/ResourceTexturedFont.java index 9e1a3fd..69553bd 100644 --- a/src/org/atriasoft/ewol/resource/ResourceTexturedFont.java +++ b/src/org/atriasoft/ewol/resource/ResourceTexturedFont.java @@ -42,8 +42,8 @@ public class ResourceTexturedFont extends ResourceTexture2 { } /** - * @brief Get all the Path contain in the specidy path: - * @param[in] _path Generic path to parse ... + * Get all the Path contain in the specidy path: + * @param _path Generic path to parse ... * @return The list of path found * @example[start] auto out = explodeMultiplePath("DATA:///font?lib=ewol"); // * out contain: {"DATA:///font", @@ -257,8 +257,8 @@ public class ResourceTexturedFont extends ResourceTexture2 { } /** - * @brief add a glyph in a texture font. - * @param[in] _val Char value to add. + * add a glyph in a texture font. + * @param _val Char value to add. * @return true if the image size have change, false otherwise */ private synchronized boolean addGlyph(final Character _val) { @@ -334,7 +334,7 @@ public class ResourceTexturedFont extends ResourceTexture2 { } /** - * @brief get the font height (user friendly) + * get the font height (user friendly) * @return Dimention of the font the user requested */ public int getFontSize() { @@ -342,9 +342,9 @@ public class ResourceTexturedFont extends ResourceTexture2 { } /** - * @brief get the pointer on the coresponding glyph - * @param[in] _charcode The unicodeValue - * @param[in] _displayMode Mode to display the currrent font + * get the pointer on the coresponding glyph + * @param _charcode The unicodeValue + * @param _displayMode Mode to display the currrent font * @return The pointer on the glyph == > never null */ public synchronized GlyphProperty getGlyph(final Character _charcode, final FontMode _displayMode) { @@ -368,8 +368,8 @@ public class ResourceTexturedFont extends ResourceTexture2 { }; /** - * @brief get the display height of this font - * @param[in] _displayMode Mode to display the currrent font + * get the display height of this font + * @param _displayMode Mode to display the currrent font * @return Dimention of the font need between 2 lines */ public int getHeight() { @@ -381,9 +381,9 @@ public class ResourceTexturedFont extends ResourceTexture2 { } /** - * @brief get the ID of a unicode charcode - * @param[in] _charcode The unicodeValue - * @param[in] _displayMode Mode to display the currrent font + * get the ID of a unicode charcode + * @param _charcode The unicodeValue + * @param _displayMode Mode to display the currrent font * @return The ID in the table (if it does not exist : return 0) */ private synchronized int getIndex(final Character _charcode, final FontMode _displayMode) { @@ -415,10 +415,10 @@ public class ResourceTexturedFont extends ResourceTexture2 { }; /** - * @brief The wrapping mode is used to prevent the non existance of a specific + * The wrapping mode is used to prevent the non existance of a specific * mode. For exemple when a blod mode does not exist, this resend a * regular mode. - * @param[in] _source The requested mode. + * @param _source The requested mode. * @return the best mode we have in stock. */ public FontMode getWrappingMode(final FontMode _source) { diff --git a/src/org/atriasoft/ewol/resource/font/GlyphProperty.java b/src/org/atriasoft/ewol/resource/font/GlyphProperty.java index 4283b7b..3d0520c 100644 --- a/src/org/atriasoft/ewol/resource/font/GlyphProperty.java +++ b/src/org/atriasoft/ewol/resource/font/GlyphProperty.java @@ -64,7 +64,7 @@ public class GlyphProperty { } /** - * @brief get the status of the char, if it exist or not in the FONT + * get the status of the char, if it exist or not in the FONT * @return true if the char is availlable, false otherwise */ public boolean exist() { @@ -89,7 +89,7 @@ public class GlyphProperty { } /** - * @brief set the element doen not exist !!! + * set the element doen not exist !!! */ public void setNotExist() { this.exist = false; diff --git a/src/org/atriasoft/ewol/resource/font/Kerning.java b/src/org/atriasoft/ewol/resource/font/Kerning.java index e471256..9acacf1 100644 --- a/src/org/atriasoft/ewol/resource/font/Kerning.java +++ b/src/org/atriasoft/ewol/resource/font/Kerning.java @@ -7,7 +7,7 @@ package org.atriasoft.ewol.resource.font; /** * @not_in_doc - * @brief Kerning properties of one specific Glyph with an other + * Kerning properties of one specific Glyph with an other * * Without Kerning : * [pre] @@ -41,7 +41,7 @@ public class Kerning { public float value; //!< kerning real offset /** - * @brief Simple ructor that allow to allocate the List element + * Simple ructor that allow to allocate the List element */ public Kerning() { this.UVal = 0; @@ -49,9 +49,9 @@ public class Kerning { }; /** - * @brief Normal ructor - * @param[in] _charcode The Unicode value of the coresponding character that might be before - * @param[in] _value The Kerning value of the offset (nb pixel number) + * Normal ructor + * @param _charcode The Unicode value of the coresponding character that might be before + * @param _value The Kerning value of the offset (nb pixel number) */ public Kerning(final Character _charcode, final float _value) { this.UVal = _charcode; diff --git a/src/org/atriasoft/ewol/tools/Message.java b/src/org/atriasoft/ewol/tools/Message.java index d29d43c..78dca14 100644 --- a/src/org/atriasoft/ewol/tools/Message.java +++ b/src/org/atriasoft/ewol/tools/Message.java @@ -11,9 +11,9 @@ import org.atriasoft.ewol.Ewol; public class Message { /** - * @brief Create a simple pop-up message on the screen for application error. - * @param[in] _type Type of the error. - * @param[in] _message message to display (decorated text) + * Create a simple pop-up message on the screen for application error. + * @param _type Type of the error. + * @param _message message to display (decorated text) */ private static void create(Type _type, String _message){ StdPopUp tmpPopUp = new StdPopUp(); @@ -37,31 +37,31 @@ public class Message { } /** - * @brief Create a simple information message - * @param[in] _message message to display (decorated text) + * Create a simple information message + * @param _message message to display (decorated text) */ public static void displayInfo(String _message){ create(Type.info, _message); } /** - * @brief Create a simple warning message - * @param[in] _message message to display (decorated text) + * Create a simple warning message + * @param _message message to display (decorated text) */ public static void displayWarning(String _message) { create(Type.warning, _message); } /** - * @brief Create a simple error message - * @param[in] _message message to display (decorated text) + * Create a simple error message + * @param _message message to display (decorated text) */ public static void displayError(String _message) { create(Type.error,_message); } /** - * @brief Create a simple critical message - * @param[in] _message message to display (decorated text) + * Create a simple critical message + * @param _message message to display (decorated text) */ public static void displayCritical(String _message){ create(Type.critical, _message); diff --git a/src/org/atriasoft/ewol/widget/Container.java b/src/org/atriasoft/ewol/widget/Container.java index f0f0d20..203630f 100644 --- a/src/org/atriasoft/ewol/widget/Container.java +++ b/src/org/atriasoft/ewol/widget/Container.java @@ -15,26 +15,26 @@ import org.atriasoft.exml.model.XmlNode; */ /* * @ingroup ewolWidgetGroup - * @brief the Cotainer widget is a widget that have an only one subWidget + * the Cotainer widget is a widget that have an only one subWidget */ class Container extends Widget { protected Widget subWidget = null; /** - * @brief Constructor + * Constructor */ public Container() { super(); } /** - * @brief get the main node widget + * get the main node widget * @return the requested pointer on the node */ public Widget getSubWidget(){ return this.subWidget; } /** - * @brief set the subWidget node widget. - * @param[in] _newWidget The widget to add. + * set the subWidget node widget. + * @param _newWidget The widget to add. */ public void setSubWidget(Widget _newWidget){ if (_newWidget == null) { @@ -49,9 +49,9 @@ class Container extends Widget { requestUpdateSize(); } /** - * @brief Replace a old subwidget with a new one. - * @param[in] _oldWidget The widget to replace. - * @param[in] _newWidget The widget to set. + * Replace a old subwidget with a new one. + * @param _oldWidget The widget to replace. + * @param _newWidget The widget to set. */ public void subWidgetReplace( Widget _oldWidget, Widget _newWidget){ @@ -68,7 +68,7 @@ class Container extends Widget { requestUpdateSize(); } /** - * @brief remove the subWidget node (async). + * remove the subWidget node (async). */ public void subWidgetRemove() { if (this.subWidget != null) { @@ -79,7 +79,7 @@ class Container extends Widget { } } /** - * @brief Unlink the subwidget Node. + * Unlink the subwidget Node. */ public void subWidgetUnLink(){ if (this.subWidget != null) { diff --git a/src/org/atriasoft/ewol/widget/ContainerN.java b/src/org/atriasoft/ewol/widget/ContainerN.java index 81e52e6..cfcb439 100644 --- a/src/org/atriasoft/ewol/widget/ContainerN.java +++ b/src/org/atriasoft/ewol/widget/ContainerN.java @@ -18,7 +18,7 @@ import java.util.List; /** * @ingroup ewolWidgetGroup - * @brief the Cotainer widget is a widget that have an only one subWidget + * the Cotainer widget is a widget that have an only one subWidget */ public class ContainerN extends Widget { @XmlManaged() @@ -29,7 +29,7 @@ public class ContainerN extends Widget { protected List subWidget = new ArrayList<>(); protected Vector2b subExpend = new Vector2b(false,false); //!< reference of the sub element expention requested. /** - * @brief Constructor + * Constructor */ protected ContainerN() {} // herited function @@ -49,7 +49,7 @@ public class ContainerN extends Widget { return res; } /** - * @brief remove all sub element from the widget. + * remove all sub element from the widget. */ public void subWidgetRemoveAll(){ for(Widget it : this.subWidget) { @@ -61,15 +61,15 @@ public class ContainerN extends Widget { this.subWidget.clear(); } /** - * @brief remove all sub element from the widget (delayed to prevent remove in the callbback). + * remove all sub element from the widget (delayed to prevent remove in the callbback). */ public void subWidgetRemoveAllDelayed(){ subWidgetRemoveAll(); } /** - * @brief Replace a old subwidget with a new one. - * @param[in] _oldWidget The widget to replace. - * @param[in] _newWidget The widget to set. + * Replace a old subwidget with a new one. + * @param _oldWidget The widget to replace. + * @param _newWidget The widget to set. */ public void subWidgetReplace(Widget _oldWidget, Widget _newWidget) { @@ -94,8 +94,8 @@ public class ContainerN extends Widget { requestUpdateSize(); } /** - * @brief add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) - * @param[in] _newWidget the element pointer + * add at end position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) + * @param _newWidget the element pointer * @return the ID of the set element */ public int subWidgetAdd(Widget _newWidget) { @@ -120,8 +120,8 @@ public class ContainerN extends Widget { return subWidgetAdd(_newWidget); }; /** - * @brief add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) - * @param[in] _newWidget the element pointer + * add at start position a Widget (note : This system use an inverted phylisophie (button to top, and left to right) + * @param _newWidget the element pointer * @return the ID of the set element */ public int subWidgetAddStart(Widget _newWidget) { @@ -142,8 +142,8 @@ public class ContainerN extends Widget { return subWidgetAddStart(_newWidget); }; /** - * @brief remove definitly a widget from the system and this layer. - * @param[in] _newWidget the element pointer. + * remove definitly a widget from the system and this layer. + * @param _newWidget the element pointer. */ public void subWidgetRemove(Widget _newWidget){ if (_newWidget == null) { @@ -165,8 +165,8 @@ public class ContainerN extends Widget { } } /** - * @brief Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...) - * @param[in] _newWidget the element pointer. + * Just unlick the specify widget, this function does not remove it from the system (if you can, do nt use it ...) + * @param _newWidget the element pointer. */ public void subWidgetUnLink(Widget _newWidget) { if (_newWidget == null) { diff --git a/src/org/atriasoft/ewol/widget/Image.java b/src/org/atriasoft/ewol/widget/Image.java index e072358..44d5a4a 100644 --- a/src/org/atriasoft/ewol/widget/Image.java +++ b/src/org/atriasoft/ewol/widget/Image.java @@ -40,25 +40,25 @@ namespace ewol { int this.colorId; //!< Color of the image. public: /** - * @brief + * */ Image(); void init() ; public: DECLARE_WIDGET_FACTORY(Image, "Image"); /** - * @brief + * */ ~Image(); /** - * @brief set All the configuration of the current image - * @param[in] _uri URI of the new image - * @param[in] _border New border size to set + * set All the configuration of the current image + * @param _uri URI of the new image + * @param _border New border size to set */ void set( etk::Uri _uri, gale::Dimension _border); /** - * @brief Set an image with direct elements - * @param[in] _image Image to set in the display + * Set an image with direct elements + * @param _image Image to set in the display */ void setCustumSource( egami::Image _image); protected: diff --git a/src/org/atriasoft/ewol/widget/Label.java b/src/org/atriasoft/ewol/widget/Label.java index 56d4f1a..daabce5 100644 --- a/src/org/atriasoft/ewol/widget/Label.java +++ b/src/org/atriasoft/ewol/widget/Label.java @@ -22,15 +22,15 @@ class Label extends Widget { int this.colorDefaultBgText; //!< Default Background color of the text protected: /** - * @brief Constructor - * @param[in] _newLabel The displayed decorated text. + * Constructor + * @param _newLabel The displayed decorated text. */ Label(); void init() ; public: DECLARE_WIDGET_FACTORY(Label, "Label"); /** - * @brief destructor + * destructor */ ~Label(); protected: diff --git a/src/org/atriasoft/ewol/widget/Sizer.java b/src/org/atriasoft/ewol/widget/Sizer.java index e91342e..a46e88d 100644 --- a/src/org/atriasoft/ewol/widget/Sizer.java +++ b/src/org/atriasoft/ewol/widget/Sizer.java @@ -14,8 +14,8 @@ public class Sizer extends ContainerN { public displayMode propertyMode; //!< Methode to display the widget list (vert/hory ...) public Dimension propertyBorderSize; //!< Border size needed for all the display /** - * @brief Constructor - * @param[in] _mode The mode to display the elements + * Constructor + * @param _mode The mode to display the elements */ public Sizer(); public void onChangeSize() ; diff --git a/src/org/atriasoft/ewol/widget/Spacer.java b/src/org/atriasoft/ewol/widget/Spacer.java index 4267834..a07073d 100644 --- a/src/org/atriasoft/ewol/widget/Spacer.java +++ b/src/org/atriasoft/ewol/widget/Spacer.java @@ -25,7 +25,7 @@ class Spacer extends Widget { @EwolDescription(value = "background of the spacer") protected Color propertyColor; //!< Background color /** - * @brief Main ructer + * Main ructer */ public Spacer() { diff --git a/src/org/atriasoft/ewol/widget/WidgetManager.java b/src/org/atriasoft/ewol/widget/WidgetManager.java index 5035282..94ce591 100644 --- a/src/org/atriasoft/ewol/widget/WidgetManager.java +++ b/src/org/atriasoft/ewol/widget/WidgetManager.java @@ -33,9 +33,9 @@ public class WidgetManager { private Runnable funcRedrawNeeded = null; /** - * @brief Create a widget with his name. - * @param[in] _name Name of the widget to create. - * @param[in] _node Reference on the XML node. + * Create a widget with his name. + * @param _name Name of the widget to create. + * @param _node Reference on the XML node. * @return The widget created (null if it does not exist). */ /* @@ -84,9 +84,9 @@ public class WidgetManager { /** * @throws Exception - * @brief add a factory of a specific widget. - * @param[in] _name Name of the widget that is associated of the factory. - * @param[in] _class class interface + * add a factory of a specific widget. + * @param _name Name of the widget that is associated of the factory. + * @param _class class interface */ public void addWidgetCreator(final String _name, final Class _class) throws Exception { if (_class == null) { @@ -104,8 +104,8 @@ public class WidgetManager { } /** - * @brief Create a widget with his name. - * @param[in] _name Name of the widget to create. + * Create a widget with his name. + * @param _name Name of the widget to create. * @return The widget created (null if it does not exist). */ public Widget create(final String _name) { @@ -141,8 +141,8 @@ public class WidgetManager { } /** - * @brief Check if an Widget exist - * @param[in] _name Name of the widget to check. + * Check if an Widget exist + * @param _name Name of the widget to check. * @return true The Widget exist. * @return false The Widget Does NOT exist. */ @@ -151,7 +151,7 @@ public class WidgetManager { } /** - * @brief Get the current Focused widget. + * Get the current Focused widget. * @return The pointer on the current focused element. */ public Widget focusGet() { @@ -159,8 +159,8 @@ public class WidgetManager { } /** - * @brief Request a focus on a specify widget. - * @param[in] _newWidget Widget that might get the focus. + * Request a focus on a specify widget. + * @param _newWidget Widget that might get the focus. */ public void focusKeep(final Widget _newWidget) { if (_newWidget == null) { @@ -187,7 +187,7 @@ public class WidgetManager { } /** - * @brief Release the current focus (back on default if possible). + * Release the current focus (back on default if possible). */ public void focusRelease() { final Widget focusWidgetDefault = this.focusWidgetDefault.get(); @@ -209,8 +209,8 @@ public class WidgetManager { } /** - * @brief Set the default focus when none selected. - * @param[in] _newWidget Widget that might get the focus (when nothing else). + * Set the default focus when none selected. + * @param _newWidget Widget that might get the focus (when nothing else). */ public void focusSetDefault(final Widget _newWidget) { if ((_newWidget != null) && (!_newWidget.propertyCanFocus)) { @@ -234,7 +234,7 @@ public class WidgetManager { } /** - * @brief Check if a redraw has been requested (set the local value back at false) + * Check if a redraw has been requested (set the local value back at false) * @return true if something to be redraw */ public boolean isDrawingNeeded() { @@ -244,7 +244,7 @@ public class WidgetManager { } /** - * @brief Get the list of all Widget that can be created. + * Get the list of all Widget that can be created. * @return Separate with ',' string list. */ public String list() { @@ -252,7 +252,7 @@ public class WidgetManager { } /** - * @brief Mark the display to redraw + * Mark the display to redraw */ public void markDrawingIsNeeded() { if (this.haveRedraw) { @@ -265,8 +265,8 @@ public class WidgetManager { } /** - * @brief Set a callback when we need redraw the display (need by MacOs) - * @param[in] _func function to call + * Set a callback when we need redraw the display (need by MacOs) + * @param _func function to call */ public void setCallbackonRedrawNeeded(final Runnable _func) { this.funcRedrawNeeded = _func; diff --git a/src/org/atriasoft/ewol/widget/Windows.java b/src/org/atriasoft/ewol/widget/Windows.java index 666e3fe..118cde3 100644 --- a/src/org/atriasoft/ewol/widget/Windows.java +++ b/src/org/atriasoft/ewol/widget/Windows.java @@ -16,7 +16,7 @@ import org.atriasoft.ewol.resource.ResourceColorFile; */ /** - * @brief Windows basic interface + * Windows basic interface */ public class Windows extends Widget { @@ -41,12 +41,12 @@ public class Windows extends Widget { public Widget getWidgetAtPos(Vector2f _pos); /** - * @brief Called when property change: Color configuration file + * Called when property change: Color configuration file */ protected void onChangePropertyColor(); /** - * @brief Called when property change: Title + * Called when property change: Title */ protected void onChangePropertyTitle(); @@ -57,7 +57,7 @@ public class Windows extends Widget { public void onRegenerateDisplay(); /** - * @brief Get the number of pop-up + * Get the number of pop-up * @return Count of pop-up */ public int popUpCount() { @@ -65,21 +65,21 @@ public class Windows extends Widget { } /** - * @brief Remove the pop-up on top. + * Remove the pop-up on top. */ public void popUpWidgetPop(); /** - * @brief Add a pop-up on the Windows. - * @param[in] _widget Widget to set on top of the pop-up. + * Add a pop-up on the Windows. + * @param _widget Widget to set on top of the pop-up. */ public void popUpWidgetPush(Widget _widget); public void requestDestroyFromChild(EwolObject _child); //!< main sub-widget of the Windows. /** - * @brief Set the main widget of the application. - * @param[in] _widget Widget to set in the windows. + * Set the main widget of the application. + * @param _widget Widget to set in the windows. */ public void setSubWidget(Widget _widget);