tasn pushed a commit to branch master. http://git.enlightenment.org/core/elementary.git/commit/?id=24fb77b0279e589738cc31f70d644a4cf8be39cb
commit 24fb77b0279e589738cc31f70d644a4cf8be39cb Author: Tom Hacohen <t...@stosb.com> Date: Fri Jul 31 16:16:13 2015 +0100 panes: Migrate docs to new Eolian format. --- src/lib/elm_panes.eo | 246 ++++++++++++--------------------------------------- 1 file changed, 55 insertions(+), 191 deletions(-) diff --git a/src/lib/elm_panes.eo b/src/lib/elm_panes.eo index 3a9b833..881eb7e 100644 --- a/src/lib/elm_panes.eo +++ b/src/lib/elm_panes.eo @@ -3,266 +3,130 @@ class Elm.Panes (Elm.Layout, Evas.Clickable_Interface) eo_prefix: elm_obj_panes; methods { @property content_left_size { - set { - /*@ - Set the size proportion of panes widget's left side. - - By default it's homogeneous, i.e., both sides have the same size. + [[Set the size proportion of panes widget's left side. - If something different is required, it can be set with this function. - For example, if the left content should be displayed over - 75% of the panes size, @p size should be passed as @c 0.75. - This way, right content will be resized to 25% of panes size. + By default it's homogeneous, i.e., both sides have the same size. - If displayed vertically, left content is displayed at top, and - right content at bottom. + If something different is required, it can be set with this function. + For example, if the left content should be displayed over + 75% of the panes size, $size should be passed as 0.75. + This way, right content will be resized to 25% of panes size. - @note This proportion will change when user drags the panes bar. + If displayed vertically, left content is displayed at top, and + right content at bottom. - @see elm_panes_content_left_size_get() - - @ingroup Panes */ + Note: This proportion will change when user drags the panes bar.]] + set { } get { - /*@ - Get the size proportion of panes widget's left side. - - @return float value between 0.0 and 1.0 representing size proportion - of left side. - - @see elm_panes_content_left_size_set() for more details. - - @ingroup Panes */ } values { - size: double; /*@ Value between 0.0 and 1.0 representing size proportion - of left side. */ + size: double; [[Value between 0.0 and 1.0 representing size proportion of left side.]] } } @property horizontal { - set { - /*@ - Set how to split and dispose each content. + [[Set how to split and dispose each content. - Use this function to change how your panes is to be disposed: - vertically or horizontally. - Horizontal panes have "top" and "bottom" contents, vertical panes have - "left" and "right" contents. + Use this function to change how your panes is to be disposed: + vertically or horizontally. + Horizontal panes have "top" and "bottom" contents, vertical panes have + "left" and "right" contents. - By default panes is in a vertical mode. - - @see elm_panes_horizontal_get() - - @ingroup Panes */ + By default panes is in a vertical mode.]] + set { } get { - /*@ - Get the split direction of a given panes widget. - - @return @c EINA_TRUE, if @p obj is set to be @b horizontal, - @c EINA_FALSE if it's @b vertical (and on errors). - - @see elm_panes_horizontal_set() for more details. - - @ingroup Panes */ } values { - horizontal: bool; /*@ Use @c EINA_TRUE to make @p obj to split panes - horizontally ("top" and "bottom" contents). @c EINA_FALSE to make it - vertically ("left" and "right" contents) */ + horizontal: bool; [[Use $true to make $obj to split panes + horizontally ("top" and "bottom" contents). $false to make it + vertically ("left" and "right" contents).]] } } @property fixed { - set { - /*@ - Set whether the left and right panes can be resized by user interaction. + [[Set whether the left and right panes can be resized by user interaction. - By default panes' contents are resizable by user interaction. - - @see elm_panes_fixed_get() - @see elm_panes_content_left_size_set() - @see elm_panes_content_right_size_set() - - @ingroup Panes */ + By default panes' contents are resizable by user interaction.]] + set { } get { - /*@ - Get the resize mode for the panes of a given panes widget. - - @return @c EINA_TRUE, if @p obj is set to be resizable by user interaction. - - @see elm_panes_fixed_set() for more details. - @see elm_panes_content_left_size_get() - @see elm_panes_content_right_size_get() - - @ingroup Panes */ } values { - fixed: bool; /*@ Use @c EINA_TRUE to fix the left and right panes sizes and make - them not to be resized by user interaction. Use @c EINA_FALSE to make them - resizable. */ + fixed: bool; [[Use $true to fix the left and right panes sizes and make + them not to be resized by user interaction. Use $false to make them + resizable.]] } } @property content_right_size { - set { - /*@ - Set the size proportion of panes widget's right side. - - By default it's homogeneous, i.e., both sides have the same size. + [[Set the size proportion of panes widget's right side. - If something different is required, it can be set with this function. - For example, if the right content should be displayed over - 75% of the panes size, @p size should be passed as @c 0.75. - This way, left content will be resized to 25% of panes size. + By default it's homogeneous, i.e., both sides have the same size. - If displayed vertically, left content is displayed at top, and - right content at bottom. + If something different is required, it can be set with this function. + For example, if the right content should be displayed over + 75% of the panes size, $size should be passed as 0.75. + This way, left content will be resized to 25% of panes size. - @note This proportion will change when user drags the panes bar. + If displayed vertically, left content is displayed at top, and + right content at bottom. - @see elm_panes_content_right_size_get() - - @ingroup Panes */ + Note: This proportion will change when user drags the panes bar.]] + set { } get { - /*@ - Get the size proportion of panes widget's right side. - - @return float value between 0.0 and 1.0 representing size proportion - of right side. - - @see elm_panes_content_right_size_set() for more details. - - @ingroup Panes */ } values { - size: double; /*@ Value between 0.0 and 1.0 representing size proportion - of right side. */ + size: double; [[Value between 0.0 and 1.0 representing size proportion of right side.]] } } @property content_left_min_relative_size { - set { - /*@ - Set the relative minimum size of panes widget's left side. - - @param obj The panes object. - @param size double value between 0.0 and 1.0 representing size - proportion of minimum size of left side. + [[Controls the relative minimum size of panes widget's left side. - @note If displayed vertically, left content is displayed at top. + proportion of minimum size of left side. - - @see elm_panes_content_left_min_size_relative_get() - - @ingroup Panes */ + Note: If displayed vertically, left content is displayed at top.]] + set { } get { - /*@ - Get the relative minimum size of panes widget's left side. - - @param obj The panes object. - @return double value between 0.0 and 1.0 representing size proportion - of minimum size of left side. - - @see elm_panes_content_left_min_relative_size_set() for more details. - - @ingroup Panes */ } values { - size: double; /*@ value between 0.0 and 1.0 representing size proportion - of minimum size of left side. */ + size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of left side.]] } } @property content_right_min_relative_size { - set { - /*@ - Set the relative minimum size of panes widget's right side. - - @param obj The panes object. - @param size double value between 0.0 and 1.0 representing size proportion - of minimum size of right side. + [[Set the relative minimum size of panes widget's right side. - @note If displayed vertically, right content is displayed at bottom. - - @see elm_panes_content_right_min_relative_size_get() - - @ingroup Panes */ + Note: If displayed vertically, right content is displayed at bottom.]] + set { } get { - /*@ - Get the relative minimum size of panes widget's right side. - - @param obj The panes object. - @return double value between 0.0 and 1.0 representing size proportion - of minimum size of right side. - - @see elm_panes_content_right_min_size_set() for more details. - - @ingroup Panes */ } values { - size: double; /*@ value between 0.0 and 1.0 representing size proportion - of minimum size of right side. */ + size: double; [[value between 0.0 and 1.0 representing size proportion of minimum size of right side.]] } } @property content_left_min_size { - set { - /*@ - Set the absolute minimum size of panes widget's left side. + [[Set the absolute minimum size of panes widget's left side. - @param obj The panes object. - @param size int value representing minimum size of left side in pixels. - - @note If displayed vertically, left content is displayed at top. - - @see elm_panes_content_left_min_size_get() - - @ingroup Panes */ + Note: If displayed vertically, left content is displayed at top.]] + set { } get { - /*@ - Get the absolute minimum size of panes widget's left side. - - @param obj The panes object. - @retur int value representing minimum size of left side in pixels. - - @see elm_panes_content_left_min_size_set() for more details. - - @ingroup Panes */ } values { - size: Evas.Coord; /*@ value representing minimum size of left side - in pixels. */ + size: Evas.Coord; [[value representing minimum size of left side in pixels.]] } } @property content_right_min_size { - set { - /*@ - Set the absolute minimum size of panes widget's right side. + [[Control the absolute minimum size of panes widget's right side. - @param obj The panes object. - @param size int value representing minimum size of right side in pixels. - - @note If displayed vertically, right content is displayed at bottom. - - @see elm_panes_content_right_min_size_get() - - @ingroup Panes */ + Note: If displayed vertically, right content is displayed at bottom.]] + set { } get { - /*@ - Get the absolute minimum size of panes widget's right side. - - @param obj The panes object. - @retur int value representing minimum size of right side in pixels. - - @see elm_panes_content_right_min_size_set() for more details. - - @ingroup Panes */ } values { - size: Evas.Coord; /*@ value representing minimum size of right side - in pixels. */ + size: Evas.Coord; [[value representing minimum size of right side in pixels.]] } } } --