eolian: fix all remaining since errors

eolian checked for since tags that are invalid by its own rules. This is
now fixed.
This commit is contained in:
Marcel Hollerbach 2020-02-05 16:22:59 +01:00
parent e52d871859
commit 33681f8087
10 changed files with 41 additions and 17 deletions

View File

@ -1,9 +1,9 @@
#version 1 #version 1
const Foo: int = 5; [[doc for constant]] const Foo: int = 5; [[doc for constant @since 1.66]]
class Class_Simple { class Class_Simple {
[[Class Desc Simple]] [[Class Desc Simple @since 1.66]]
c_prefix: efl_canvas_object_simple; c_prefix: efl_canvas_object_simple;
data: Evas_Simple_Data; data: Evas_Simple_Data;
methods { methods {

View File

@ -13,6 +13,8 @@ typedef Eo Class_Simple;
#ifndef FOO #ifndef FOO
/** doc for constant /** doc for constant
*
* @since 1.66
* *
* @ingroup Foo * @ingroup Foo
*/ */
@ -22,6 +24,8 @@ typedef Eo Class_Simple;
#endif #endif
/** Class Desc Simple /** Class Desc Simple
*
* @since 1.66
* *
* @ingroup Class_Simple * @ingroup Class_Simple
*/ */
@ -40,6 +44,8 @@ EWAPI const Efl_Class *class_simple_class_get(void);
* *
* @return comment for property set return * @return comment for property set return
* *
* @since 1.66
*
* @ingroup Class_Simple * @ingroup Class_Simple
*/ */
EOAPI Eina_Bool efl_canvas_object_simple_a_set(Eo *obj, int value); 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 * @return Value description
* *
* @since 1.66
*
* @ingroup Class_Simple * @ingroup Class_Simple
*/ */
EOAPI int efl_canvas_object_simple_a_get(const Eo *obj); 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 * @return comment for method return
* *
* @since 1.66
*
* @ingroup Class_Simple * @ingroup Class_Simple
*/ */
EOAPI char *efl_canvas_object_simple_foo(Eo *obj, int a, char *b, double *c, int *d); EOAPI char *efl_canvas_object_simple_foo(Eo *obj, int a, char *b, double *c, int *d);

View File

@ -1,4 +1,5 @@
class Consts { class Consts {
[[Consts @since 1.66]]
methods { methods {
foo @const { foo @const {
[[comment foo]] [[comment foo]]

View File

@ -60,7 +60,7 @@ typedef enum
* *
* More docs for typedef. See @ref Bar. * More docs for typedef. See @ref Bar.
* *
* @since 2.0 * @since 1.1337
* *
* @ingroup Alias * @ingroup Alias
*/ */
@ -68,6 +68,8 @@ typedef Bar Alias;
#ifndef PANTS #ifndef PANTS
/** Docs for var. /** Docs for var.
*
* @since 1.66
* *
* @ingroup pants * @ingroup pants
*/ */
@ -75,6 +77,8 @@ typedef Bar Alias;
#endif #endif
/** Opaque struct docs. See @ref Foo for another struct. /** Opaque struct docs. See @ref Foo for another struct.
*
* @since 1.66
* *
* @ingroup Opaque * @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 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 * @ref eo_docs_prop_set @ref Foo.field1 @ref BAR_FOO @ref Eo_Docs
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @ingroup Eo_Docs
*/ */
@ -107,7 +111,7 @@ EWAPI const Efl_Class *eo_docs_class_get(void);
* *
* @return Return documentation. * @return Return documentation.
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @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] obj The object.
* @param[in] val Value documentation. * @param[in] val Value documentation.
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @ingroup Eo_Docs
*/ */
@ -136,7 +140,7 @@ EOAPI void eo_docs_prop_set(Eo *obj, int val);
* *
* @return Value documentation. * @return Value documentation.
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @ingroup Eo_Docs
*/ */
@ -146,7 +150,7 @@ EOAPI void eo_docs_no_doc_meth(Eo *obj);
/** No description supplied. /** No description supplied.
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @ingroup Eo_Docs
*/ */
@ -156,7 +160,7 @@ EWAPI extern const Efl_Event_Description _EO_DOCS_EVENT_CLICKED;
/** Event docs. /** Event docs.
* *
* @since 1.18 * @since 1.66
* *
* @ingroup Eo_Docs * @ingroup Eo_Docs
*/ */

View File

@ -30,12 +30,12 @@ enum Bar {
type Alias: Bar; [[Docs for typedef. type Alias: Bar; [[Docs for typedef.
More 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 { class Eo_Docs {
[[Docs for class. [[Docs for class.
@ -53,7 +53,7 @@ class Eo_Docs {
@Bar.foo @Bar.foo
@Eo_Docs @Eo_Docs
@since 1.18 @since 1.66
]] ]]
methods { methods {
meth { meth {
@ -67,8 +67,6 @@ class Eo_Docs {
} }
@property prop { @property prop {
[[Property common documentation. [[Property common documentation.
@since 1.18
]] ]]
get { get {
[[Get documentation.]] [[Get documentation.]]

View File

@ -1,4 +1,5 @@
abstract Object_Impl extends Base { abstract Object_Impl extends Base {
[[Object Impl @since 1.66]]
methods { methods {
@property a @beta { @property a @beta {
set { set {

View File

@ -1,4 +1,5 @@
abstract Override extends Base { abstract Override extends Base {
[[Override @since 1.66]]
methods { methods {
@property a { @property a {
set @pure_virtual { set @pure_virtual {

View File

@ -15,6 +15,7 @@ struct @extern Not.Generated {
} }
class Struct { class Struct {
[[Struct @since 1.66]]
methods { methods {
foo { foo {
[[Foo docs. This is $monospace. This is alone-standing $.]] [[Foo docs. This is $monospace. This is alone-standing $.]]

View File

@ -26,6 +26,12 @@ typedef struct _Opaque Opaque;
#endif #endif
/** Struct
*
* @since 1.66
*
* @ingroup Struct
*/
#define STRUCT_CLASS struct_class_get() #define STRUCT_CLASS struct_class_get()
EWAPI const Efl_Class *struct_class_get(void); 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] obj The object.
* @param[in] idx * @param[in] idx
* *
* @since 1.66
*
* @ingroup Struct * @ingroup Struct
*/ */
EOAPI char *struct_foo(Eo *obj, int idx) EFL_TRANSFER_OWNERSHIP EINA_WARN_UNUSED_RESULT; EOAPI char *struct_foo(Eo *obj, int idx) EFL_TRANSFER_OWNERSHIP EINA_WARN_UNUSED_RESULT;

View File

@ -1175,7 +1175,7 @@ EFL_START_TEST(eolian_docs)
fail_if(strcmp(eolian_documentation_description_get(doc), fail_if(strcmp(eolian_documentation_description_get(doc),
"More docs for typedef. See @Bar.")); "More docs for typedef. See @Bar."));
fail_if(strcmp(eolian_documentation_since_get(doc), 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(!(var = eolian_unit_constant_by_name_get(unit, "pants")));
fail_if(!(doc = eolian_constant_documentation_get(var))); fail_if(!(doc = eolian_constant_documentation_get(var)));
@ -1237,7 +1237,7 @@ EFL_START_TEST(eolian_docs)
"Property common documentation.")); "Property common documentation."));
fail_if(eolian_documentation_description_get(doc)); fail_if(eolian_documentation_description_get(doc));
fail_if(strcmp(eolian_documentation_since_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(!(doc = eolian_implement_documentation_get(fimp, EOLIAN_PROP_GET)));
fail_if(strcmp(eolian_documentation_summary_get(doc), fail_if(strcmp(eolian_documentation_summary_get(doc),
"Get documentation.")); "Get documentation."));