From 33681f80879b62f4347b5f7d05f5220bc1d40c14 Mon Sep 17 00:00:00 2001 From: Marcel Hollerbach Date: Wed, 5 Feb 2020 16:22:59 +0100 Subject: [PATCH] eolian: fix all remaining since errors eolian checked for since tags that are invalid by its own rules. This is now fixed. --- src/tests/eolian/data/class_simple.eo | 4 ++-- src/tests/eolian/data/class_simple_ref_eo.h | 10 ++++++++++ src/tests/eolian/data/consts.eo | 1 + src/tests/eolian/data/docs_ref.h | 18 +++++++++++------- src/tests/eolian/data/eo_docs.eo | 10 ++++------ src/tests/eolian/data/object_impl.eo | 1 + src/tests/eolian/data/override.eo | 1 + src/tests/eolian/data/struct.eo | 1 + src/tests/eolian/data/struct_ref.h | 8 ++++++++ src/tests/eolian/eolian_parsing.c | 4 ++-- 10 files changed, 41 insertions(+), 17 deletions(-) diff --git a/src/tests/eolian/data/class_simple.eo b/src/tests/eolian/data/class_simple.eo index 12ea743b48..a912f001b0 100644 --- a/src/tests/eolian/data/class_simple.eo +++ b/src/tests/eolian/data/class_simple.eo @@ -1,9 +1,9 @@ #version 1 -const Foo: int = 5; [[doc for constant]] +const Foo: int = 5; [[doc for constant @since 1.66]] class Class_Simple { - [[Class Desc Simple]] + [[Class Desc Simple @since 1.66]] c_prefix: efl_canvas_object_simple; data: Evas_Simple_Data; methods { diff --git a/src/tests/eolian/data/class_simple_ref_eo.h b/src/tests/eolian/data/class_simple_ref_eo.h index d0a6d02ce8..e3c093b372 100644 --- a/src/tests/eolian/data/class_simple_ref_eo.h +++ b/src/tests/eolian/data/class_simple_ref_eo.h @@ -13,6 +13,8 @@ typedef Eo Class_Simple; #ifndef FOO /** doc for constant + * + * @since 1.66 * * @ingroup Foo */ @@ -22,6 +24,8 @@ typedef Eo Class_Simple; #endif /** Class Desc Simple + * + * @since 1.66 * * @ingroup Class_Simple */ @@ -40,6 +44,8 @@ EWAPI const Efl_Class *class_simple_class_get(void); * * @return comment for property set return * + * @since 1.66 + * * @ingroup Class_Simple */ EOAPI Eina_Bool efl_canvas_object_simple_a_set(Eo *obj, int value); @@ -53,6 +59,8 @@ EOAPI Eina_Bool efl_canvas_object_simple_a_set(Eo *obj, int value); * * @return Value description * + * @since 1.66 + * * @ingroup Class_Simple */ EOAPI int efl_canvas_object_simple_a_get(const Eo *obj); @@ -70,6 +78,8 @@ EOAPI int efl_canvas_object_simple_a_get(const Eo *obj); * * @return comment for method return * + * @since 1.66 + * * @ingroup Class_Simple */ EOAPI char *efl_canvas_object_simple_foo(Eo *obj, int a, char *b, double *c, int *d); diff --git a/src/tests/eolian/data/consts.eo b/src/tests/eolian/data/consts.eo index 9505e95387..877c7869cb 100644 --- a/src/tests/eolian/data/consts.eo +++ b/src/tests/eolian/data/consts.eo @@ -1,4 +1,5 @@ class Consts { + [[Consts @since 1.66]] methods { foo @const { [[comment foo]] diff --git a/src/tests/eolian/data/docs_ref.h b/src/tests/eolian/data/docs_ref.h index a00fafb5a5..cb5fd6401c 100644 --- a/src/tests/eolian/data/docs_ref.h +++ b/src/tests/eolian/data/docs_ref.h @@ -60,7 +60,7 @@ typedef enum * * More docs for typedef. See @ref Bar. * - * @since 2.0 + * @since 1.1337 * * @ingroup Alias */ @@ -68,6 +68,8 @@ typedef Bar Alias; #ifndef PANTS /** Docs for var. + * + * @since 1.66 * * @ingroup pants */ @@ -75,6 +77,8 @@ typedef Bar Alias; #endif /** Opaque struct docs. See @ref Foo for another struct. + * + * @since 1.66 * * @ingroup Opaque */ @@ -89,7 +93,7 @@ typedef struct _Opaque Opaque; * @ref PANTS @ref eo_docs_meth @ref eo_docs_prop_get @ref eo_docs_prop_get * @ref eo_docs_prop_set @ref Foo.field1 @ref BAR_FOO @ref Eo_Docs * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ @@ -107,7 +111,7 @@ EWAPI const Efl_Class *eo_docs_class_get(void); * * @return Return documentation. * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ @@ -121,7 +125,7 @@ EOAPI int eo_docs_meth(Eo *obj, int a, float *b, long *c); * @param[in] obj The object. * @param[in] val Value documentation. * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ @@ -136,7 +140,7 @@ EOAPI void eo_docs_prop_set(Eo *obj, int val); * * @return Value documentation. * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ @@ -146,7 +150,7 @@ EOAPI void eo_docs_no_doc_meth(Eo *obj); /** No description supplied. * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ @@ -156,7 +160,7 @@ EWAPI extern const Efl_Event_Description _EO_DOCS_EVENT_CLICKED; /** Event docs. * - * @since 1.18 + * @since 1.66 * * @ingroup Eo_Docs */ diff --git a/src/tests/eolian/data/eo_docs.eo b/src/tests/eolian/data/eo_docs.eo index 8c62559d5a..4857aff665 100644 --- a/src/tests/eolian/data/eo_docs.eo +++ b/src/tests/eolian/data/eo_docs.eo @@ -30,12 +30,12 @@ enum Bar { type Alias: Bar; [[Docs for typedef. More docs for typedef. - See @Bar. @since 2.0 + See @Bar. @since 1.1337 ]] -const pants: int = 150; [[Docs for var.]] +const pants: int = 150; [[Docs for var. @since 1.66]] -struct Opaque; [[Opaque struct docs. See @Foo for another struct.]] +struct Opaque; [[Opaque struct docs. See @Foo for another struct. @since 1.66]] class Eo_Docs { [[Docs for class. @@ -53,7 +53,7 @@ class Eo_Docs { @Bar.foo @Eo_Docs - @since 1.18 + @since 1.66 ]] methods { meth { @@ -67,8 +67,6 @@ class Eo_Docs { } @property prop { [[Property common documentation. - - @since 1.18 ]] get { [[Get documentation.]] diff --git a/src/tests/eolian/data/object_impl.eo b/src/tests/eolian/data/object_impl.eo index aa708a8bd7..8a592069ca 100644 --- a/src/tests/eolian/data/object_impl.eo +++ b/src/tests/eolian/data/object_impl.eo @@ -1,4 +1,5 @@ abstract Object_Impl extends Base { + [[Object Impl @since 1.66]] methods { @property a @beta { set { diff --git a/src/tests/eolian/data/override.eo b/src/tests/eolian/data/override.eo index 4cee6008d3..2652b3febd 100644 --- a/src/tests/eolian/data/override.eo +++ b/src/tests/eolian/data/override.eo @@ -1,4 +1,5 @@ abstract Override extends Base { + [[Override @since 1.66]] methods { @property a { set @pure_virtual { diff --git a/src/tests/eolian/data/struct.eo b/src/tests/eolian/data/struct.eo index 57f250bdbe..12c254ff53 100644 --- a/src/tests/eolian/data/struct.eo +++ b/src/tests/eolian/data/struct.eo @@ -15,6 +15,7 @@ struct @extern Not.Generated { } class Struct { + [[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 ec7ea52671..4e07d4ec8c 100644 --- a/src/tests/eolian/data/struct_ref.h +++ b/src/tests/eolian/data/struct_ref.h @@ -26,6 +26,12 @@ typedef struct _Opaque Opaque; #endif +/** Struct + * + * @since 1.66 + * + * @ingroup Struct + */ #define STRUCT_CLASS struct_class_get() EWAPI const Efl_Class *struct_class_get(void); @@ -36,6 +42,8 @@ EWAPI const Efl_Class *struct_class_get(void); * @param[in] obj The object. * @param[in] idx * + * @since 1.66 + * * @ingroup Struct */ EOAPI char *struct_foo(Eo *obj, int idx) EFL_TRANSFER_OWNERSHIP EINA_WARN_UNUSED_RESULT; diff --git a/src/tests/eolian/eolian_parsing.c b/src/tests/eolian/eolian_parsing.c index b21af5a5c7..60e24bda41 100644 --- a/src/tests/eolian/eolian_parsing.c +++ b/src/tests/eolian/eolian_parsing.c @@ -1175,7 +1175,7 @@ EFL_START_TEST(eolian_docs) fail_if(strcmp(eolian_documentation_description_get(doc), "More docs for typedef. See @Bar.")); fail_if(strcmp(eolian_documentation_since_get(doc), - "2.0")); + "1.1337")); fail_if(!(var = eolian_unit_constant_by_name_get(unit, "pants"))); fail_if(!(doc = eolian_constant_documentation_get(var))); @@ -1237,7 +1237,7 @@ EFL_START_TEST(eolian_docs) "Property common documentation.")); fail_if(eolian_documentation_description_get(doc)); fail_if(strcmp(eolian_documentation_since_get(doc), - "1.18")); + "1.66")); fail_if(!(doc = eolian_implement_documentation_get(fimp, EOLIAN_PROP_GET))); fail_if(strcmp(eolian_documentation_summary_get(doc), "Get documentation."));