From bbd4b6e5148727b601954aa3bc2c7f50cf4dfba6 Mon Sep 17 00:00:00 2001 From: Xavi Artigas Date: Wed, 20 Mar 2019 19:46:44 +0100 Subject: docs: Remove obsolete @since tags from EO files Summary: All legacy @since tags have already moved to the *.legacy.h files. EO files are now devoid of @since tags (except some eldbus still needed for legacy). Upcoming patches will add @since 1.22 to those APIs which come out of beta in this release. APIs marked @beta do not need @since tags. Test Plan: Everything builds, EO docs (like DocFX) have no Since tags. Reviewers: zmike, bu5hm4n, lauromoura, cedric Reviewed By: cedric Subscribers: cedric, #reviewers, #committers Tags: #efl Differential Revision: https://phab.enlightenment.org/D8430 --- src/lib/ecore_audio/ecore_audio.eo | 12 ------------ src/lib/ecore_audio/ecore_audio_in.eo | 22 ---------------------- src/lib/ecore_audio/ecore_audio_out.eo | 6 ------ 3 files changed, 40 deletions(-) (limited to 'src/lib/ecore_audio') diff --git a/src/lib/ecore_audio/ecore_audio.eo b/src/lib/ecore_audio/ecore_audio.eo index af668fb..93409d2 100644 --- a/src/lib/ecore_audio/ecore_audio.eo +++ b/src/lib/ecore_audio/ecore_audio.eo @@ -21,8 +21,6 @@ abstract @beta Ecore.Audio extends Efl.Object methods { @property paused { [[Pauses state of the object - - @since 1.8 ]] set { } @@ -34,8 +32,6 @@ abstract @beta Ecore.Audio extends Efl.Object } @property volume { [[Volume of the object - - @since 1.8 ]] set { } @@ -51,8 +47,6 @@ abstract @beta Ecore.Audio extends Efl.Object What sources are supported depends on the actual object. For example, the libsndfile class accepts WAV, OGG, FLAC files as source. - - @since 1.8 ]] set { return: bool; [[$true if the source was set correctly (i.e. the file @@ -71,8 +65,6 @@ abstract @beta Ecore.Audio extends Efl.Object What formats are supported depends on the actual object. Default is ECORE_AUDIO_FORMAT_AUTO - - @since 1.8 ]] return: bool; [[$true if the format was supported, $false otherwise]] } @@ -81,8 +73,6 @@ abstract @beta Ecore.Audio extends Efl.Object After setting the source if the format was ECORE_AUDIO_FORMAT_AUTO this function will now return the actual format. - - @since 1.8 ]] } values { @@ -91,8 +81,6 @@ abstract @beta Ecore.Audio extends Efl.Object } vio_set @pure_virtual { [[Sets the virtual IO functions - - @since 1.8 ]] params { vio: ptr(Ecore.Audio.Vio); [[The @Ecore.Audio.Vio struct with diff --git a/src/lib/ecore_audio/ecore_audio_in.eo b/src/lib/ecore_audio/ecore_audio_in.eo index 7c8582f..bbee8e1 100644 --- a/src/lib/ecore_audio/ecore_audio_in.eo +++ b/src/lib/ecore_audio/ecore_audio_in.eo @@ -7,8 +7,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio methods { @property speed { [[Playback speed of the input. - - @since 1.8 ]] set { } @@ -20,8 +18,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } @property samplerate { [[Sample-rate of the input - - @since 1.8 ]] set { } @@ -33,8 +29,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } @property channels { [[Amount of channels the input has - - @since 1.8 ]] set { } @@ -46,8 +40,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } @property preloaded { [[Preloaded state of the input - - @since 1.8 ]] set { } @@ -63,8 +55,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio If the input is looped and reaches the end it will start from the beginning again. At the same time the event \@ref ECORE_AUDIO_EV_IN_LOOPED will be emitted - - @since 1.8 ]] set { } @@ -79,8 +69,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio This function is only implemented by some classes (i.e. ECORE_AUDIO_OBJ_IN_TONE_CLASS) - - @since 1.8 ]] set { } @@ -93,8 +81,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio @property output { get { [[Gets the output that this input is attached to - - @since 1.8 ]] } values { @@ -104,8 +90,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio @property remaining { get { [[Gets the remaining time of the input - - @since 1.8 ]] } values { @@ -114,8 +98,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } read { [[Reads from the input - - @since 1.8 ]] return: ssize; [[The amount of samples written to buf]] params { @@ -125,8 +107,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } read_internal { [[Internal read function - - @since 1.8 ]] return: ssize; [[The amount of samples written to buf]] params { @@ -136,8 +116,6 @@ class @beta Ecore.Audio.In extends Ecore.Audio } seek { [[Seeks within the input - - @since 1.8 ]] return: double; [[The current absolute position in seconds within the input]] diff --git a/src/lib/ecore_audio/ecore_audio_out.eo b/src/lib/ecore_audio/ecore_audio_out.eo index 59821c3..f18dd8d 100644 --- a/src/lib/ecore_audio/ecore_audio_out.eo +++ b/src/lib/ecore_audio/ecore_audio_out.eo @@ -7,8 +7,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio methods { input_attach { [[Attaches an input to an output - - @since 1.8 ]] return: bool; [[$true if the input was attached, $false otherwise]] params { @@ -17,8 +15,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio } input_detach { [[Detaches an input from an output - - @since 1.8 ]] return: bool; [[$true if the input was detached, $false otherwise]] params { @@ -27,8 +23,6 @@ abstract @beta Ecore.Audio.Out extends Ecore.Audio } inputs_get { [[Returns the list of all attached inputs - - @since 1.8 ]] return: list; [[A list of the inputs that are attached to the output]] } -- cgit v1.1