diff options
author | Lucas Cavalcante de Sousa <lucas@expertisesolutions.com.br> | 2020-02-05 11:58:17 -0300 |
---|---|---|
committer | Marcel Hollerbach <mail@marcel-hollerbach.de> | 2020-02-05 17:15:33 +0100 |
commit | 269ed1ca346b79ed08776af429d1f09ab055bf3e (patch) | |
tree | 672e9fc119dd33ba03f679355848b6503af1d3df | |
parent | 534cd92c8710909aa585b0d98981c2ae6adadc5a (diff) | |
download | efl-269ed1ca346b79ed08776af429d1f09ab055bf3e.tar.gz |
bindings-cxx: fix missing @since tags at stable c#/cpp tests
Story:
This revision got landed twice, I do not know what happend, but when i
wanted to land that initially with git phab, something reseted the state
of this revision to the initial version, and also changed the
authorship. This time, this commit contains all changes, and the correct
authorship, sorry for the noise.
Summary:
Add @since tags at stable (not tagged with @beta) `.eo` c#/c++ tests. Doing so,
eolian_enforce_since shouldn't accuse at stable tests.
Depends on D11264
Resolves T8600
Reviewers: zmike, segfaultxavi, woohyun, bu5hm4n
Subscribers: cedric, #reviewers, #committers
Tags: #efl
Maniphest Tasks: T8600
Differential Revision: https://phab.enlightenment.org/D11265
59 files changed, 280 insertions, 87 deletions
diff --git a/src/tests/efl_js/benchmark_object.eo b/src/tests/efl_js/benchmark_object.eo index 65b65665e2..eea958c932 100644 --- a/src/tests/efl_js/benchmark_object.eo +++ b/src/tests/efl_js/benchmark_object.eo @@ -1,5 +1,6 @@ -class Benchmark_Object extends Efl.Object -{ +class Benchmark_Object extends Efl.Object { + [[Docs for class Benchmark_Object. @since 1.66]] + data: null; methods { emptyarg { diff --git a/src/tests/efl_mono/dummy_child.eo b/src/tests/efl_mono/dummy_child.eo index f6de361c45..2b476a5b81 100644 --- a/src/tests/efl_mono/dummy_child.eo +++ b/src/tests/efl_mono/dummy_child.eo @@ -4,6 +4,7 @@ class Dummy.Child extends Dummy.Test_Object { methods { double_params { + [[Docs for method double_params. @since 1.66]] params { @in a: string; @in b: double; @@ -11,6 +12,7 @@ class Dummy.Child extends Dummy.Test_Object { } @property iface_was_set { + [[Docs for property iface_was_set. @since 1.66]] get {} values { data: bool; @@ -30,6 +32,7 @@ class Dummy.Child extends Dummy.Test_Object { } @property obligatory_beta_ctor_was_called { + [[Docs for property obligatory_beta_ctor_was_called. @since 1.66]] get{} values { data: bool; @@ -37,6 +40,7 @@ class Dummy.Child extends Dummy.Test_Object { } @property optional_beta_ctor_was_called { + [[Docs for property optional_beta_ctor_was_called. @since 1.66]] get{} values { data: bool; diff --git a/src/tests/efl_mono/dummy_hidden_object.eo b/src/tests/efl_mono/dummy_hidden_object.eo index 1b29472a1c..6fab21119c 100644 --- a/src/tests/efl_mono/dummy_hidden_object.eo +++ b/src/tests/efl_mono/dummy_hidden_object.eo @@ -1,2 +1,3 @@ class Dummy.Hidden_Object extends Efl.Object { + [[Docs for class Dummy.Hidden_Object. @since 1.66]] } diff --git a/src/tests/efl_mono/dummy_inherit_helper.eo b/src/tests/efl_mono/dummy_inherit_helper.eo index f0f9183ebb..9bc909e206 100644 --- a/src/tests/efl_mono/dummy_inherit_helper.eo +++ b/src/tests/efl_mono/dummy_inherit_helper.eo @@ -1,5 +1,5 @@ -class Dummy.Inherit_Helper extends Efl.Object -{ +class Dummy.Inherit_Helper extends Efl.Object { + [[Docs for class Dummy.Inherit_Helper. @since 1.66]] methods { receive_dummy_and_call_int_out @static { params { diff --git a/src/tests/efl_mono/dummy_inherit_iface.eo b/src/tests/efl_mono/dummy_inherit_iface.eo index e18403fcd2..be1cdae05e 100644 --- a/src/tests/efl_mono/dummy_inherit_iface.eo +++ b/src/tests/efl_mono/dummy_inherit_iface.eo @@ -1,4 +1,5 @@ interface Dummy.Inherit_Iface { + [[Docs for interface Dummy.Inherit_Iface. @since 1.66]] methods { stringshare_test { params { diff --git a/src/tests/efl_mono/dummy_numberwrapper.eo b/src/tests/efl_mono/dummy_numberwrapper.eo index 98b265233c..8811fc0b16 100644 --- a/src/tests/efl_mono/dummy_numberwrapper.eo +++ b/src/tests/efl_mono/dummy_numberwrapper.eo @@ -1,4 +1,5 @@ class Dummy.Numberwrapper extends Efl.Object { + [[Docs for class Dummy.Numberwrapper. @since 1.66]] methods { @property number { get { diff --git a/src/tests/efl_mono/dummy_part_holder.eo b/src/tests/efl_mono/dummy_part_holder.eo index 1ac88007fc..d096e8ffef 100644 --- a/src/tests/efl_mono/dummy_part_holder.eo +++ b/src/tests/efl_mono/dummy_part_holder.eo @@ -1,6 +1,7 @@ import eina_types; class Dummy.Part_Holder extends Dummy.Test_Object implements Efl.Part { + [[Docs for class Dummy.Part_Holder. @since 1.66]] parts { one: Dummy.Test_Object; [[ Part number one. ]] diff --git a/src/tests/efl_mono/dummy_test_object.eo b/src/tests/efl_mono/dummy_test_object.eo index 41c947ee07..a0199cb808 100644 --- a/src/tests/efl_mono/dummy_test_object.eo +++ b/src/tests/efl_mono/dummy_test_object.eo @@ -1,20 +1,21 @@ import eina_types; -type Dummy.MyInt: int; - -const Dummy.Constvar_Bool : bool = true; -const Dummy.Constvar_Int : int = -32766; -const Dummy.Constvar_UInt : uint = 65533U; -const Dummy.Constvar_Long : long = -2147483644L; -const Dummy.Constvar_ULong : ulong = 4294967288UL; -const Dummy.Constvar_LLong : llong = -9223372036854775800LL; -const Dummy.Constvar_ULLong : ullong = 18446744073709551615ULL; -const Dummy.Constvar_Float : float = 16777211.0f; -const Dummy.Constvar_Double : double = 9007199254740988.0; -const Dummy.Constvar_Char : char = '!'; -const Dummy.Constvar_String : string = "test_str"; +type Dummy.MyInt: int; [[Docs for typedef Dummy. @since 1.66]] + +const Dummy.Constvar_Bool : bool = true; [[Docs for var Dummy.Constvar_Bool. @since 1.66]] +const Dummy.Constvar_Int : int = -32766; [[Docs for var Dummy.Constvar_Int. @since 1.66]] +const Dummy.Constvar_UInt : uint = 65533U; [[Docs for var Dummy.Constvar_UInt. @since 1.66]] +const Dummy.Constvar_Long : long = -2147483644L; [[Docs for var Dummy.Constvar_Long. @since 1.66]] +const Dummy.Constvar_ULong : ulong = 4294967288UL; [[Docs for var Dummy.Constvar_ULong @since 1.66]] +const Dummy.Constvar_LLong : llong = -9223372036854775800LL; [[Docs for var Dummy.Constvar_LLong. @since 1.66]] +const Dummy.Constvar_ULLong : ullong = 18446744073709551615ULL; [[Docs for var Dummy.Constvar_ULLong. @since 1.66]] +const Dummy.Constvar_Float : float = 16777211.0f; [[Docs for var Dummy.Constvar_Float. @since 1.66]] +const Dummy.Constvar_Double : double = 9007199254740988.0; [[Docs for var Dummy.Constvar_Double. @since 1.66]] +const Dummy.Constvar_Char : char = '!'; [[Docs for var Dummy.Constvar_Char. @since 1.66]] +const Dummy.Constvar_String : string = "test_str"; [[Docs for var Dummy.Constvar_String. @since 1.66]] enum Dummy.SampleEnum { + [[Docs for enum Dummy.SampleEnum. @since 1.66]] v0, v1, v2, @@ -22,8 +23,8 @@ enum Dummy.SampleEnum { v4, } -struct @free(free) Dummy.StructSimple -{ +struct @free(free) Dummy.StructSimple { + [[Docs for struct Dummy.StructSimple. @since 1.66]] fbyte: byte; fubyte: ubyte; fchar: char; @@ -87,6 +88,7 @@ struct @beta @free(free) Dummy.StructComplex { } function Dummy.SimpleCb { + [[Docs for function Dummy.SimpleCb. @since 1.66]] params { a: int; } @@ -94,6 +96,7 @@ function Dummy.SimpleCb { }; function Dummy.FormatCb { + [[Docs for function Dummy.FormatCb. @since 1.66]] params { @in str: strbuf; @in value: const(any_value); diff --git a/src/tests/eina_cxx/eina_simple.eo b/src/tests/eina_cxx/eina_simple.eo index 4034dd6642..725d1824ab 100644 --- a/src/tests/eina_cxx/eina_simple.eo +++ b/src/tests/eina_cxx/eina_simple.eo @@ -1,5 +1,5 @@ -class Eina_Simple extends Efl.Object -{ +class Eina_Simple extends Efl.Object { + [[Docs for Eona_Simple. @since 1.66]] data: null; implements { Efl.Object.constructor; diff --git a/src/tests/eolian/data/base.eo b/src/tests/eolian/data/base.eo index 4f1b93d518..ddfd5716d7 100644 --- a/src/tests/eolian/data/base.eo +++ b/src/tests/eolian/data/base.eo @@ -1,4 +1,5 @@ abstract Base { + [[Docs for abstract class Base. @since 1.66]] methods { @property z { values { diff --git a/src/tests/eolian/data/class_funcs.eo b/src/tests/eolian/data/class_funcs.eo index 087f380003..7d72d2fca2 100644 --- a/src/tests/eolian/data/class_funcs.eo +++ b/src/tests/eolian/data/class_funcs.eo @@ -1,4 +1,5 @@ class Class_Funcs { + [[Docs for class Class_Funcs. @since 1.66]] methods { @property a @static { get { diff --git a/src/tests/eolian/data/class_requires.eo b/src/tests/eolian/data/class_requires.eo index ffbb4fef8d..fb33314c87 100644 --- a/src/tests/eolian/data/class_requires.eo +++ b/src/tests/eolian/data/class_requires.eo @@ -2,6 +2,7 @@ import base; import mixins_require; class Class.Requires extends Base implements Mixins.Require { + [[Docs for class Class.Requires. @since 1.66]] methods { } diff --git a/src/tests/eolian/data/consts.eo b/src/tests/eolian/data/consts.eo index 877c7869cb..953310541d 100644 --- a/src/tests/eolian/data/consts.eo +++ b/src/tests/eolian/data/consts.eo @@ -1,5 +1,5 @@ class Consts { - [[Consts @since 1.66]] + [[Docs for class Consts. @since 1.66]] methods { foo @const { [[comment foo]] diff --git a/src/tests/eolian/data/ctor_dtor.eo b/src/tests/eolian/data/ctor_dtor.eo index 71bdcede81..0e82c23520 100644 --- a/src/tests/eolian/data/ctor_dtor.eo +++ b/src/tests/eolian/data/ctor_dtor.eo @@ -1,4 +1,5 @@ class Ctor_Dtor extends Base { + [[Docs for class Ctor_Dtor. @since 1.66]] methods { custom_constructor_1 { params { diff --git a/src/tests/eolian/data/enum.eo b/src/tests/eolian/data/enum.eo index 0cfc78dd42..cf8115d64a 100644 --- a/src/tests/eolian/data/enum.eo +++ b/src/tests/eolian/data/enum.eo @@ -1,23 +1,27 @@ // regular named enum enum Foo { + [[Docs for enum Foo. @since 1.66]] first, bar, baz = 5 * 3 } enum Baz { + [[Docs for enum Baz. @since 1.66]] flag1 = 1 << 0, flag2 = 1 << 1, flag3 = 1 << 2, // testing trailing comma on last item } enum Name.Spaced { + [[Docs for enum Name.Space. @since 1.66]] pants } -const Bah: Baz = Baz.flag1; +const Bah: Baz = Baz.flag1; [[Docs for var Bah. @since 1.66]] enum Value { + [[Docs for enum Value. @since 1.66]] foo, bar, baz = 2, @@ -26,9 +30,10 @@ enum Value { pants } -const Pants: Value = Value.pants; +const Pants: Value = Value.pants; [[Docs for var Pants. @since 1.66]] class Enum { + [[Docs for class Enum. @since 1.66]] methods { foo { params { diff --git a/src/tests/eolian/data/error.eo b/src/tests/eolian/data/error.eo index 3a5867ac8d..34b1a1a129 100644 --- a/src/tests/eolian/data/error.eo +++ b/src/tests/eolian/data/error.eo @@ -1,4 +1,4 @@ -error Foo = "something bad happened"; [[Error doc]] +error Foo = "something bad happened"; [[Error doc. @since 1.66]] error @beta Bar = "another bad thing happened"; [[Another error doc]] class @beta Error { diff --git a/src/tests/eolian/data/events.eo b/src/tests/eolian/data/events.eo index 95b6a8f43c..04047e1157 100644 --- a/src/tests/eolian/data/events.eo +++ b/src/tests/eolian/data/events.eo @@ -1,4 +1,5 @@ struct Evas_Event_Clicked_Double_Info { + [[Docs for struct Evas_Event_Clicked_Double_Info. @since 1.66]] pants: int; } diff --git a/src/tests/eolian/data/extern.eo b/src/tests/eolian/data/extern.eo index 28ceb7e2aa..455541a809 100644 --- a/src/tests/eolian/data/extern.eo +++ b/src/tests/eolian/data/extern.eo @@ -1,22 +1,23 @@ /* regular type */ -type Foo: int; +type Foo: int; [[Docs for typedef Foo. @since 1.66]] /* extern type */ -type @extern Evas.Coord: int; +type @extern Evas.Coord: int; [[Docs for typedef Evas.Coord. @since 1.66]] /* regular struct */ -struct X -{ +struct X { + [[Docs for struct X. @since 1.66]] field: int; } /* extern struct */ -struct @extern Y -{ +struct @extern Y { + [[Docs for struct Y. @since 1.66]] field: int; } class Extern { + [[Docs for class Extern. @since 1.66]] methods { foo { params { diff --git a/src/tests/eolian/data/free_func.eo b/src/tests/eolian/data/free_func.eo index b10c74db6a..2aee43b294 100644 --- a/src/tests/eolian/data/free_func.eo +++ b/src/tests/eolian/data/free_func.eo @@ -1,16 +1,19 @@ /* regular struct */ struct Named1 { + [[Docs for struct Named1. @since 1.66]] field: int; } struct @free(test_free) Named2 { + [[Docs for struct Named2. @since 1.66]] field: int; } /* opaque */ -struct Opaque1; -struct @free(opaque_free) Opaque2; +struct Opaque1; [[Docs for Opaque1. @since 1.66]] +struct @free(opaque_free) Opaque2; [[Docs for struct Opaque2. @since 1.66]] class Free_Func { + [[Docs for class Free_Func. @since 1.66]] methods { foo { params { diff --git a/src/tests/eolian/data/function_as_argument.eo b/src/tests/eolian/data/function_as_argument.eo index 29b0f4b91c..7d8424c663 100644 --- a/src/tests/eolian/data/function_as_argument.eo +++ b/src/tests/eolian/data/function_as_argument.eo @@ -1,6 +1,7 @@ import function_types; class Function_As_Argument { + [[Docs for class Function_As_Argument. @since 1.66]] methods { set_cb { params { diff --git a/src/tests/eolian/data/function_as_argument_ref.h b/src/tests/eolian/data/function_as_argument_ref.h index b93a3e02ed..56a8e3effa 100644 --- a/src/tests/eolian/data/function_as_argument_ref.h +++ b/src/tests/eolian/data/function_as_argument_ref.h @@ -13,6 +13,12 @@ typedef Eo Function_As_Argument; #endif +/** Docs for class Function_As_Argument. + * + * @since 1.66 + * + * @ingroup Function_As_Argument + */ #define FUNCTION_AS_ARGUMENT_CLASS function_as_argument_class_get() EWAPI const Efl_Class *function_as_argument_class_get(void); diff --git a/src/tests/eolian/data/iface.eo b/src/tests/eolian/data/iface.eo index 153bc0f914..72857f6054 100644 --- a/src/tests/eolian/data/iface.eo +++ b/src/tests/eolian/data/iface.eo @@ -1,4 +1,5 @@ interface Iface { + [[Docs for interface Iface. @since 1.66]] methods { foo {} bar {} diff --git a/src/tests/eolian/data/import.eo b/src/tests/eolian/data/import.eo index 894842487d..258ed454d5 100644 --- a/src/tests/eolian/data/import.eo +++ b/src/tests/eolian/data/import.eo @@ -1,8 +1,9 @@ import import_types; class Import { + [[Docs for class Import. @since 1.66]] methods { foo { } } -}
\ No newline at end of file +} diff --git a/src/tests/eolian/data/mixins_require.eo b/src/tests/eolian/data/mixins_require.eo index 474e1a3af1..ece6f0e82e 100644 --- a/src/tests/eolian/data/mixins_require.eo +++ b/src/tests/eolian/data/mixins_require.eo @@ -2,6 +2,7 @@ import base; import class_simple; mixin Mixins.Require requires Base { + [[Docs for mixin Mixins.Require. @since 1.66]] methods { test { diff --git a/src/tests/eolian/data/nmsp1_class1.eo b/src/tests/eolian/data/nmsp1_class1.eo index a494e5e1c5..e15bfdc0e0 100644 --- a/src/tests/eolian/data/nmsp1_class1.eo +++ b/src/tests/eolian/data/nmsp1_class1.eo @@ -1,5 +1,5 @@ -class nmsp1.class1 extends nmsp1.nmsp11.class2 implements nmsp2.class1, no_nmsp -{ +class nmsp1.class1 extends nmsp1.nmsp11.class2 implements nmsp2.class1, no_nmsp { + [[Docs for class nmsp1.class1. @since 1.66]] implements { nmsp1.nmsp11.class2.a { set; } no_nmsp.foo; diff --git a/src/tests/eolian/data/nmsp1_nmsp11_class2.eo b/src/tests/eolian/data/nmsp1_nmsp11_class2.eo index 40c7b854b9..3a3018832c 100644 --- a/src/tests/eolian/data/nmsp1_nmsp11_class2.eo +++ b/src/tests/eolian/data/nmsp1_nmsp11_class2.eo @@ -1,5 +1,5 @@ -abstract nmsp1.nmsp11.class2 -{ +abstract nmsp1.nmsp11.class2 { + [[Docs for abstract nmsp1.nmsp11.class2. @since 1.66]] methods { @property a { set @pure_virtual { diff --git a/src/tests/eolian/data/nmsp2_class1.eo b/src/tests/eolian/data/nmsp2_class1.eo index e92be95c1d..058f5fefdf 100644 --- a/src/tests/eolian/data/nmsp2_class1.eo +++ b/src/tests/eolian/data/nmsp2_class1.eo @@ -1,3 +1,3 @@ -mixin nmsp2.class1 -{ +mixin nmsp2.class1 { + [[Docs for mixin nmsp2.class1. @since 1.66]] } diff --git a/src/tests/eolian/data/no_nmsp.eo b/src/tests/eolian/data/no_nmsp.eo index daf4313282..30108ffcc9 100644 --- a/src/tests/eolian/data/no_nmsp.eo +++ b/src/tests/eolian/data/no_nmsp.eo @@ -1,5 +1,5 @@ -mixin no_nmsp -{ +mixin no_nmsp { + [[Docs for mixin no_nmsp . @since 1.66]] methods { foo { } diff --git a/src/tests/eolian/data/object_impl.eo b/src/tests/eolian/data/object_impl.eo index 8a592069ca..10d85b2d05 100644 --- a/src/tests/eolian/data/object_impl.eo +++ b/src/tests/eolian/data/object_impl.eo @@ -1,5 +1,7 @@ abstract Object_Impl extends Base { - [[Object Impl @since 1.66]] + [[This Object Impl + @since 1.66 + ]] methods { @property a @beta { set { @@ -18,6 +20,7 @@ abstract Object_Impl extends Base { } } @property b { + [[Docs for property b. @since 1.66]] set { } get @pure_virtual { @@ -28,15 +31,17 @@ abstract Object_Impl extends Base { } } constructor_1 { + [[Docs for method constructor_1. @since 1.66]] params { @in a: int; @in b: char; } } constructor_2 { + [[Docs for method constructor_2. @since 1.66]] } foo1 { - [[comment foo]] + [[comment foo. @since 1.66]] params { @in a: int; [[a]] @inout b: char; @@ -45,13 +50,14 @@ abstract Object_Impl extends Base { return: mstring (null); [[comment for method return]] } foo2 @const { - [[comment foo]] + [[comment foo. @since 1.66]] params { @in a: int; @in b: string; } } pure_foo3 @pure_virtual { + [[Docs for method pure_foo3. @since 1.66]] /* set as virtual pure - no implementation expected */ } } diff --git a/src/tests/eolian/data/override.eo b/src/tests/eolian/data/override.eo index 2652b3febd..dbd2b50ee9 100644 --- a/src/tests/eolian/data/override.eo +++ b/src/tests/eolian/data/override.eo @@ -1,5 +1,5 @@ abstract Override extends Base { - [[Override @since 1.66]] + [[Docs for abstract class Override. @since 1.66]] methods { @property a { set @pure_virtual { diff --git a/src/tests/eolian/data/scope.eo b/src/tests/eolian/data/scope.eo index def94d1d08..7f4da220bb 100644 --- a/src/tests/eolian/data/scope.eo +++ b/src/tests/eolian/data/scope.eo @@ -1,4 +1,5 @@ class Scope { + [[Docs for class Scope. @since 1.66]] methods { @property a @protected { get { diff --git a/src/tests/eolian/data/struct.eo b/src/tests/eolian/data/struct.eo index 12c254ff53..96ed3c528e 100644 --- a/src/tests/eolian/data/struct.eo +++ b/src/tests/eolian/data/struct.eo @@ -1,21 +1,24 @@ struct Named { + [[Docs for struct Named. @since 1.66]] field: int @by_ref; something: string; } struct Another { + [[Docs for struct Another. @since 1.66]] field: Named; } /* opaque struct */ -struct Opaque; +struct Opaque; [[Docs for struct Opaque. @since 1.66]] struct @extern Not.Generated { + [[Docs for struct Not.Generated. @since 1.66]] field: int; } class Struct { - [[Struct @since 1.66]] + [[Docs for class Struct. @since 1.66]] methods { foo { [[Foo docs. This is $monospace. This is alone-standing $.]] diff --git a/src/tests/eolian/data/struct_ref.h b/src/tests/eolian/data/struct_ref.h index 4e07d4ec8c..a5a1f5e0f8 100644 --- a/src/tests/eolian/data/struct_ref.h +++ b/src/tests/eolian/data/struct_ref.h @@ -11,22 +11,40 @@ typedef Eo Struct; #ifndef _STRUCT_EO_TYPES #define _STRUCT_EO_TYPES +/** Docs for struct Named. + * + * @since 1.66 + * + * @ingroup Named + */ typedef struct _Named { int *field; const char *something; } Named; +/** Docs for struct Another. + * + * @since 1.66 + * + * @ingroup Another + */ typedef struct _Another { Named field; } Another; +/** Docs for struct Opaque. + * + * @since 1.66 + * + * @ingroup Opaque + */ typedef struct _Opaque Opaque; #endif -/** Struct +/** Docs for class Struct. * * @since 1.66 * diff --git a/src/tests/eolian/data/struct_ref_stub.h b/src/tests/eolian/data/struct_ref_stub.h index 5ef89d3c1a..724509d2b5 100644 --- a/src/tests/eolian/data/struct_ref_stub.h +++ b/src/tests/eolian/data/struct_ref_stub.h @@ -3,10 +3,28 @@ typedef Eo Struct; +/** Docs for struct Named. + * + * @since 1.66 + * + * @ingroup Named + */ typedef struct _Named Named; +/** Docs for struct Another. + * + * @since 1.66 + * + * @ingroup Another + */ typedef struct _Another Another; +/** Docs for struct Opaque. + * + * @since 1.66 + * + * @ingroup Opaque + */ typedef struct _Opaque Opaque; diff --git a/src/tests/eolian/data/typedef.eo b/src/tests/eolian/data/typedef.eo index cb97dd12ad..27aced1b42 100644 --- a/src/tests/eolian/data/typedef.eo +++ b/src/tests/eolian/data/typedef.eo @@ -1,15 +1,15 @@ -type Evas.Coord: int; /* Simple type definition */ -type List_Objects: iterator<Typedef>; /* A little more complex */ +type Evas.Coord: int; /* Simple type definition */ [[Docs for typedef Evas.Coord. @since 1.66]] +type List_Objects: iterator<Typedef>; /* A little more complex */ [[Docs for typedef List_Objects. @since 1.66]] -type Evas.Coord2: Evas.Coord; -type Evas.Coord3: Evas.Coord2; +type Evas.Coord2: Evas.Coord; [[Docs for typedef Evas.Coord2. @since 1.66]] +type Evas.Coord3: Evas.Coord2; [[Docs for typedef Evas.Coord3. @since 1.66]] -type @extern Evas.Pants: float; /* not generated */ +type @extern Evas.Pants: float; /* not generated */ [[Docs for typedef Evas.Pants. @since 1.66]] type @beta Undef: __undefined_type; /* not generated */ -enum Elm.Object.Select_Mode -{ +enum Elm.Object.Select_Mode { + [[Docs for enum Elm.Object.Select_Mode. @since 1.66]] default = 0, always, none, @@ -18,6 +18,7 @@ enum Elm.Object.Select_Mode } class Typedef { + [[Docs for class Typedef. @since 1.66]] methods { foo { params { diff --git a/src/tests/eolian/data/typedef_ref.h b/src/tests/eolian/data/typedef_ref.h index 2a3b888394..440123e867 100644 --- a/src/tests/eolian/data/typedef_ref.h +++ b/src/tests/eolian/data/typedef_ref.h @@ -11,14 +11,44 @@ typedef Eo Typedef; #ifndef _TYPEDEF_EO_TYPES #define _TYPEDEF_EO_TYPES +/** Docs for typedef Evas.Coord. + * + * @since 1.66 + * + * @ingroup Evas_Coord + */ typedef int Evas_Coord; +/** Docs for typedef List_Objects. + * + * @since 1.66 + * + * @ingroup List_Objects + */ typedef Eina_Iterator *List_Objects; +/** Docs for typedef Evas.Coord2. + * + * @since 1.66 + * + * @ingroup Evas_Coord2 + */ typedef Evas_Coord Evas_Coord2; +/** Docs for typedef Evas.Coord3. + * + * @since 1.66 + * + * @ingroup Evas_Coord3 + */ typedef Evas_Coord2 Evas_Coord3; +/** Docs for enum Elm.Object.Select_Mode. + * + * @since 1.66 + * + * @ingroup Elm_Object_Select_Mode + */ typedef enum { ELM_OBJECT_SELECT_MODE_DEFAULT = 0, @@ -30,6 +60,12 @@ typedef enum #endif +/** Docs for class Typedef. + * + * @since 1.66 + * + * @ingroup Typedef + */ #define TYPEDEF_CLASS typedef_class_get() EWAPI const Efl_Class *typedef_class_get(void); diff --git a/src/tests/eolian/data/typedef_ref_stub.h b/src/tests/eolian/data/typedef_ref_stub.h index 1b18c46031..fb0adab671 100644 --- a/src/tests/eolian/data/typedef_ref_stub.h +++ b/src/tests/eolian/data/typedef_ref_stub.h @@ -3,12 +3,36 @@ typedef Eo Typedef; +/** Docs for typedef Evas.Coord. + * + * @since 1.66 + * + * @ingroup Evas_Coord + */ typedef int Evas_Coord; +/** Docs for typedef List_Objects. + * + * @since 1.66 + * + * @ingroup List_Objects + */ typedef Eina_Iterator *List_Objects; +/** Docs for typedef Evas.Coord2. + * + * @since 1.66 + * + * @ingroup Evas_Coord2 + */ typedef Evas_Coord Evas_Coord2; +/** Docs for typedef Evas.Coord3. + * + * @since 1.66 + * + * @ingroup Evas_Coord3 + */ typedef Evas_Coord2 Evas_Coord3; diff --git a/src/tests/eolian/data/unimpl.eo b/src/tests/eolian/data/unimpl.eo index 1e11a85e93..422fe5f5e0 100644 --- a/src/tests/eolian/data/unimpl.eo +++ b/src/tests/eolian/data/unimpl.eo @@ -1,4 +1,5 @@ class Unimpl composites Iface { + [[Docs for clss Unimpl. @since 1.66]] implements { Iface.foo; } diff --git a/src/tests/eolian/data/var.eo b/src/tests/eolian/data/var.eo index 6424427ae0..c6a29ca62f 100644 --- a/src/tests/eolian/data/var.eo +++ b/src/tests/eolian/data/var.eo @@ -1,7 +1,8 @@ // regular constant -const Foo: int = 5; +const Foo: int = 5; [[Docs for var Foo. @since 1.66]] class Var { + [[Docs for class Var. @since 1.66]] methods { foo { params { diff --git a/src/tests/eolian/data_aux/aux_a.eo b/src/tests/eolian/data_aux/aux_a.eo index b79d8877e3..4b3f5b28a0 100644 --- a/src/tests/eolian/data_aux/aux_a.eo +++ b/src/tests/eolian/data_aux/aux_a.eo @@ -1,4 +1,5 @@ class Aux_A extends Aux_C { + [[Docs for class Aux_A. @since 1.66]] methods { baz {} } diff --git a/src/tests/eolian/data_aux/aux_b.eo b/src/tests/eolian/data_aux/aux_b.eo index 728c465790..b8e9f115d1 100644 --- a/src/tests/eolian/data_aux/aux_b.eo +++ b/src/tests/eolian/data_aux/aux_b.eo @@ -1,2 +1,3 @@ class Aux_B extends Aux_C { + [[Docs for class Aux_B. @since 1.66]] } diff --git a/src/tests/eolian/data_aux/aux_c.eo b/src/tests/eolian/data_aux/aux_c.eo index 7e67ed547d..c1b748ff0c 100644 --- a/src/tests/eolian/data_aux/aux_c.eo +++ b/src/tests/eolian/data_aux/aux_c.eo @@ -1,4 +1,5 @@ class Aux_C { + [[Docs for class Aux_C. @since 1.66]] methods { foo {} bar {} diff --git a/src/tests/eolian/generated_future.eo b/src/tests/eolian/generated_future.eo index 4cf5518f93..d8d8ff7757 100644 --- a/src/tests/eolian/generated_future.eo +++ b/src/tests/eolian/generated_future.eo @@ -1,5 +1,5 @@ -class Generated_Future extends Efl.Object -{ +class Generated_Future extends Efl.Object { + [[Docs for class Generated_Future. @since 1.66]] methods { } } diff --git a/src/tests/eolian_cxx/a.eo b/src/tests/eolian_cxx/a.eo index cc94262821..1319f4a14d 100644 --- a/src/tests/eolian_cxx/a.eo +++ b/src/tests/eolian_cxx/a.eo @@ -1,5 +1,5 @@ -class A extends Efl.Object -{ +class A extends Efl.Object { + [[Docs for class A. @since 1.66]] data: A_Data; implements { Efl.Object.constructor; diff --git a/src/tests/eolian_cxx/b.eo b/src/tests/eolian_cxx/b.eo index c293edc9c0..ebec257987 100644 --- a/src/tests/eolian_cxx/b.eo +++ b/src/tests/eolian_cxx/b.eo @@ -1,5 +1,5 @@ -class B extends A -{ +class B extends A { + [[Docs for class B. @since 1.66]] data: B_Data; implements { Efl.Object.constructor; diff --git a/src/tests/eolian_cxx/c.eo b/src/tests/eolian_cxx/c.eo index fe7921c67a..b66aea15c8 100644 --- a/src/tests/eolian_cxx/c.eo +++ b/src/tests/eolian_cxx/c.eo @@ -1,5 +1,5 @@ -class C extends B -{ +class C extends B { + [[Docs for class C. @since 1.66]] data: C_Data; implements { Efl.Object.constructor; diff --git a/src/tests/eolian_cxx/callback.eo b/src/tests/eolian_cxx/callback.eo index 6dd2c721b7..24f2e45f90 100644 --- a/src/tests/eolian_cxx/callback.eo +++ b/src/tests/eolian_cxx/callback.eo @@ -1,11 +1,11 @@ -struct Callback_Event -{ +struct Callback_Event { + [[Docs for struct Callback_Event. @since 1.66]] field1: int; field2: list<string>; } -class Callback extends Efl.Object -{ +class Callback extends Efl.Object { + [[Docs for class Callback. @since 1.66]] data: Callback_Data; events { prefix,event1: void; diff --git a/src/tests/eolian_cxx/complex.eo b/src/tests/eolian_cxx/complex.eo index 4ec79fb0af..d48003ea46 100644 --- a/src/tests/eolian_cxx/complex.eo +++ b/src/tests/eolian_cxx/complex.eo @@ -1,5 +1,4 @@ -class Complex extends Efl.Object -{ +class Complex extends Efl.Object { data: Complex_Data; methods { // container test @@ -49,11 +48,13 @@ class Complex extends Efl.Object } } inarray { + [[Docs for method inarray. @since 1.66]] params { l: array<string>; } } inarrayown { + [[Docs for method inarrayown. @since 1.66]] params { l: array<string> @move; } @@ -69,21 +70,25 @@ class Complex extends Efl.Object } } initerator { + [[Docs for method initerator. @since 1.66]] params { l: iterator<int>; } } initeratorown { + [[Docs for method initeratorown. @since 1.66]] params { l: iterator<int> @move; } } inaccessor { + [[Docs for method inacessor. @since 1.66]] params { l: accessor<int>; } } inaccessorown { + [[Docs for method inaccessorown. @since 1.66]] params { l: accessor<int> @move; } @@ -130,11 +135,13 @@ class Complex extends Efl.Object } } outarray { + [[Docs for method outarray. @since 1.66]] params { @out l: array<string>; } } outarrayown { + [[Docs for method outarryown. @since 1.66]] params { @out l: array<string> @move; } @@ -150,21 +157,25 @@ class Complex extends Efl.Object } } outiterator { + [[Docs for method outiterator. @since 1.66]] params { @out l: iterator<int>; } } outiteratorown { + [[Docs for method outiteratorown. @since 1.66]] params { @out l: iterator<int> @move; } } outaccessor { + [[Docs for method outaccessor. @since 1.66]] params { @out l: accessor<int>; } } outaccessorown { + [[Docs for method outaccessorown. @since 1.66]] params { @out l: accessor<int> @move; } @@ -175,22 +186,27 @@ class Complex extends Efl.Object } } bar { + [[Docs for method bar. @since 1.66]] return: array<string>; } wrapper_r { + [[Docs for method wrapper_r. @since 1.66]] return: Complex; } wrapper_in { + [[Docs for method wrapper_in. @since 1.66]] params { @in a1: Complex; } } wrapper_inout { + [[Docs for method wrapper_inout. @since 1.66]] params { @inout a1: Complex; } } wrapper_out { + [[Docs for method wrapper_out. @since 1.66]] params { @out a1: Complex; } diff --git a/src/tests/eolian_cxx/cyclic1.eo b/src/tests/eolian_cxx/cyclic1.eo index 519a08e760..0a19603ad9 100644 --- a/src/tests/eolian_cxx/cyclic1.eo +++ b/src/tests/eolian_cxx/cyclic1.eo @@ -1,5 +1,5 @@ -class Cyclic1 -{ +class Cyclic1 { + [[Docs for class Cyclic1. @since 1.66]] methods { foo { return: Cyclic2; diff --git a/src/tests/eolian_cxx/cyclic2.eo b/src/tests/eolian_cxx/cyclic2.eo index 1fbed3f1f4..5d0c19585e 100644 --- a/src/tests/eolian_cxx/cyclic2.eo +++ b/src/tests/eolian_cxx/cyclic2.eo @@ -1,5 +1,5 @@ -class Cyclic2 -{ +class Cyclic2 { + [[Docs for class Cyclic2. @since 1.66]] methods { foo { return: Cyclic1; diff --git a/src/tests/eolian_cxx/generic.eo b/src/tests/eolian_cxx/generic.eo index 327aafd9af..e803ebb2dd 100644 --- a/src/tests/eolian_cxx/generic.eo +++ b/src/tests/eolian_cxx/generic.eo @@ -5,17 +5,17 @@ struct @beta Generic.Beta_Event field2: list<string>; } -struct Generic.Event -{ +struct Generic.Event { + [[Docs for struct Generic.Event. @since 1.66]] field1: int; field2: array<string>; } -class Generic extends Efl.Object implements Generic_Interface -{ +class Generic extends Efl.Object implements Generic_Interface { data: Generic_Data; methods { @property req_ctor_a_value { + [[Docs for property req_actor_a_value. @since 1.66]] get { } values { @@ -23,6 +23,7 @@ class Generic extends Efl.Object implements Generic_Interface } } @property opt_ctor_a_value { + [[Docs for property property opt_ctor_a_value. @since 1.66]] get { } values { @@ -30,100 +31,122 @@ class Generic extends Efl.Object implements Generic_Interface } } required_ctor_a { + [[Docs for method required_ctor_a. @since 1.66]] params { @in value: int; } } required_ctor_b { + [[Docs for method required_ctor_b. @since 1.66]] params { @in value: int; } } optional_ctor_a { + [[Docs for method optional_ctor_a. @since 1.66]] params { @in value: int; } } optional_ctor_b { + [[Docs for method optional_ctor_b. @since 1.66]] params { @in value: int; } } @property req_ctor_b_value { + [[Docs for property rec_ctor_b_value. @since 1.66]] get {} values { value: int; } } @property opt_ctor_b_value { + [[Docs for property opt_ctor_b_value. @since 1.66]] get {} values { value: int; } } out_required_ctor_a { + [[Docs for method out_required_ctor_a. @since 1.66]] params { @out value: int; } } out_required_ctor_b { + [[Docs for method out_required_ctor_b. @since 1.66]] params { @out value: int; } } out_optional_ctor_a { + [[Docs for method out_optional_ctor_a. @since 1.66]] params { @out value: int; } } out_optional_ctor_b { + [[Docs for method out_optional_ctor_b. @since 1.66]] params { @out value: int; } } call_event1 { + [[Docs for method call_event1. @since 1.66]] } call_event2 { + [[Docs for method call_event2. @since 1.66]] } call_event3 { + [[Docs for method call_event3. @since 1.66]] } call_event4 { + [[Docs for method call_event4. @since 1.66]] } call_event5 { + [[Docs for method call_event5. @since 1.66]] } call_event6 { + [[Docs for method call_event6. @since 1.66]] } protected_method1 @protected { + [[Docs for protected method protected_method1. @since 1.66]] } beta_method1 @beta { } protected_beta_method1 @protected @beta { } event_param { + [[Docs for method event_param. @since 1.66]] params { value: event; } } const_event_param { + [[Docs for method const_event_param. @since 1.66]] params { value: const(event); } } binbuf_param { + [[Docs for method binbuf_param. @since 1.66]] params { value: binbuf; } } const_binbuf_param { + [[Docs for method const_binbuf_param. @since 1.66]] params { value: const(binbuf); } } } constructors { + [[Docs for constructors. @since 1.66]] .required_ctor_a; .required_ctor_b; .optional_ctor_a @optional; diff --git a/src/tests/eolian_cxx/generic_interface.eo b/src/tests/eolian_cxx/generic_interface.eo index 9f11c1a73c..659faa4531 100644 --- a/src/tests/eolian_cxx/generic_interface.eo +++ b/src/tests/eolian_cxx/generic_interface.eo @@ -1,3 +1,3 @@ -interface Generic_Interface -{ +interface Generic_Interface { + [[Docs for interface Generic_Interface. @since 1.66]] } diff --git a/src/tests/eolian_cxx/name_name.eo b/src/tests/eolian_cxx/name_name.eo index 64b0db1ab4..3fe2224ce3 100644 --- a/src/tests/eolian_cxx/name_name.eo +++ b/src/tests/eolian_cxx/name_name.eo @@ -1,3 +1,4 @@ class Name.Name { + [[Docs for class Name.Name. @since 1.66]] } diff --git a/src/tests/eolian_cxx/ns_name.eo b/src/tests/eolian_cxx/ns_name.eo index 9610d82f23..7bc76bcace 100644 --- a/src/tests/eolian_cxx/ns_name.eo +++ b/src/tests/eolian_cxx/ns_name.eo @@ -1,3 +1,4 @@ class Ns.Name { + [[Docs for NS.Name. @since 1.66]] } diff --git a/src/tests/eolian_cxx/ns_name_other.eo b/src/tests/eolian_cxx/ns_name_other.eo index a8983c45c6..c20bf4d2e3 100644 --- a/src/tests/eolian_cxx/ns_name_other.eo +++ b/src/tests/eolian_cxx/ns_name_other.eo @@ -1,3 +1,4 @@ class Ns.Name.Other { + [[Docs for Ns.Name.Other. @since 1.66]] } diff --git a/src/tests/eolian_cxx/property_holder.eo b/src/tests/eolian_cxx/property_holder.eo index 8509ffe648..91a9788d73 100644 --- a/src/tests/eolian_cxx/property_holder.eo +++ b/src/tests/eolian_cxx/property_holder.eo @@ -1,5 +1,5 @@ -class Property_Holder extends Efl.Object -{ +class Property_Holder extends Efl.Object { + [[Docs for class Property_Holder. @since 1.66]] methods { some_method { return: int; diff --git a/src/tests/eolian_cxx/simple.eo b/src/tests/eolian_cxx/simple.eo index f6f340f131..08725366c8 100644 --- a/src/tests/eolian_cxx/simple.eo +++ b/src/tests/eolian_cxx/simple.eo @@ -1,5 +1,5 @@ -class Simple extends Efl.Object -{ +class Simple extends Efl.Object { + [[Docs for class Simple. @since 1.66]] data: null; methods { simple_get { diff --git a/src/tests/eolian_js/constructor_method_class.eo b/src/tests/eolian_js/constructor_method_class.eo index 1bcfd375eb..b90518052b 100644 --- a/src/tests/eolian_js/constructor_method_class.eo +++ b/src/tests/eolian_js/constructor_method_class.eo @@ -1,5 +1,5 @@ -class Constructor_Method_Class extends Efl.Object -{ +class Constructor_Method_Class extends Efl.Object { + [[Docs for class Constructor_Method_Class. @since 1.66]] data: Constructor_Method_Class_Data; methods { @property fail { diff --git a/src/tests/eolian_js/test_object.eo b/src/tests/eolian_js/test_object.eo index 21bc5b8311..0d713d8623 100644 --- a/src/tests/eolian_js/test_object.eo +++ b/src/tests/eolian_js/test_object.eo @@ -1,4 +1,5 @@ enum Test.Enum_Ex { + [[Docs for enum Test.Enum_Ex. @since 1.66]] first = 0, second, third, @@ -6,11 +7,13 @@ enum Test.Enum_Ex { } struct Test.Struct_Ex { + [[Docs for struct Test.Struct_Ex. @since 1.66]] value_int: int; value_enum: Test.Enum_Ex; } class Test.Object extends Efl.Object { + [[Docs for class Test.Object. @since 1.66]] methods { method_integral_in_a_check { [[ tests integral in ]] |