q66 pushed a commit to branch master. http://git.enlightenment.org/core/efl.git/commit/?id=0d0439ecc374270dd59cf2789eb0c816ef688869
commit 0d0439ecc374270dd59cf2789eb0c816ef688869 Author: Daniel Kolesa <d.kol...@osg.samsung.com> Date: Tue Jun 16 15:36:33 2015 +0100 efl_player: convert docs --- src/lib/efl/interfaces/efl_player.eo | 122 ++++++++++++++--------------------- 1 file changed, 50 insertions(+), 72 deletions(-) diff --git a/src/lib/efl/interfaces/efl_player.eo b/src/lib/efl/interfaces/efl_player.eo index f2f70a3..c73fa19 100644 --- a/src/lib/efl/interfaces/efl_player.eo +++ b/src/lib/efl/interfaces/efl_player.eo @@ -2,139 +2,117 @@ interface Efl.Player { legacy_prefix: null; methods { @property playable { - /*@ - * @brief Whether or not the object data can be played. - */ + [[Whether or not the object data can be played.]] get { } values { - play: bool; /*@ true if the object have playable data, false otherwise */ + play: bool; [[true if the object have playable data, false otherwise]] } } @property play { set { - /*@ - * @brief Set play/pause state of the media file. - * - * This functions sets the currently playing status of the video. Using this - * function to play or pause the video doesn't alter it's current position. - */ + [[Set play/pause state of the media file. + + This functions sets the currently playing status of the + video. Using this function to play or pause the video + doesn't alter it's current position. + ]] } get { - /*@ - * @brief Get play/pause state of the media file. - */ + [[Get play/pause state of the media file.]] } values { - play: bool; /*@ true if playing, false otherwise. */ + play: bool; [[true if playing, false otherwise.]] } } @property position { set { - /*@ - * @brief Set the position in the media file. - * - * @param obj The emotion object whose position will be changed. - * @param sec The position(in seconds) to which the media file will be set. - * - * This functions sets the current position of the media file to @p sec, this - * only works on seekable streams. Setting the position doesn't change the - * playing state of the media file. - */ + [[Set the position in the media file. + + This functions sets the current position of the media file + to "sec", this only works on seekable streams. Setting the + position doesn't change the playing state of the media file. + ]] } get { - /*@ - * @brief Get the position in the media file. - * - * @param obj The emotion object from which the position will be retrieved. - * @return The position of the media file. - * - * The position is returned as the number of seconds since the beginning of the - * media file. - */ + [[Get the position in the media file. + + The position is returned as the number of seconds since the + beginning of the media file. + ]] } values { - second: double; /*@ The position (in seconds). */ + sec: double; [[The position (in seconds).]] } } @property progress { get { - /*@ - * @brief Get how much of the file has been played. - * - * This function gets the progress in playing the file, the return value is in - * the [0, 1] range. - */ + [[Get how much of the file has been played. + + This function gets the progress in playing the file, the + return value is in the [0, 1] range. + ]] } values { - progress: double; /*@ The progress within the [0, 1] range. */ + progress: double; [[The progress within the [0, 1] range.]] } } @property play_speed { - /*@ - * @brief Control the play speed of the media file. - * - * This function control the speed with which the media file will be played. 1.0 - * represents the normal speed, 2 double speed, 0.5 half speed and so on. - * - */ + [[Control the play speed of the media file. + + This function control the speed with which the media file will + be played. 1.0 represents the normal speed, 2 double speed, 0.5 + half speed and so on. + ]] set { } get { } values { - speed: double; /*@ The play speed in the [0, infinity) range. */ + speed: double; [[The play speed in the [0, infinity) range.]] } } @property audio_volume { - /*@ - * @brief Control the audio volume. - * - * Controls the audio volume of the stream being played. This has nothing to do with - * the system volume. This volume will be multiplied by the system volume. e.g.: - * if the current volume level is 0.5, and the system volume is 50%, it will be - * 0.5 * 0.5 = 0.25. - */ + [[Control the audio volume. + + Controls the audio volume of the stream being played. This has + nothing to do with the system volume. This volume will be + multiplied by the system volume. e.g.: if the current volume + level is 0.5, and the system volume is 50%, it will be + 0.5 * 0.5 = 0.25. + ]] set { } get { } values { - volume: double; /*@ The volume level */ + volume: double; [[The volume level]] } } @property audio_mute { - /*@ - * @brief This property controls the audio mute state. - */ + [[This property controls the audio mute state.]] set { } get { } values { - mute: bool; /*@ The mute state. True or false. */ + mute: bool; [[The mute state. True or false.]] } } @property length { - /*@ - * @brief Get the length of play for the media file. - * - * This function returns the length of the media file in seconds. - */ + [[Get the length of play for the media file.]] get { } values { - length: double; /*@ The length of the stream in seconds. */ + length: double; [[The length of the stream in seconds.]] } } @property seekable { - /*@ - * @brief Get whether the media file is seekable. - */ + [[Get whether the media file is seekable.]] get { } values { - seekable: bool; /*@ True if seekable. */ + seekable: bool; [[True if seekable.]] } } } --