eolian gen: generate documentation for first object param if present
This prevents doxygen from emitting warnings. Fixes T6186.
This commit is contained in:
parent
d24c00d2be
commit
5699466dba
|
@ -569,6 +569,17 @@ eo_gen_docs_func_gen(const Eolian_Unit *src, const Eolian_Function *fid,
|
|||
}
|
||||
}
|
||||
|
||||
if (!eolian_function_is_class(fid))
|
||||
{
|
||||
_indent_line(buf, indent);
|
||||
eina_strbuf_append(buf, " * @param[in] obj The object.\n");
|
||||
if (!par && (rdoc || since))
|
||||
{
|
||||
_indent_line(buf, indent);
|
||||
eina_strbuf_append(buf, " *\n");
|
||||
}
|
||||
}
|
||||
|
||||
while (par)
|
||||
{
|
||||
const Eolian_Documentation *adoc = eolian_parameter_documentation_get(par);
|
||||
|
|
|
@ -47,6 +47,7 @@ EWAPI const Efl_Class *class_simple_class_get(void);
|
|||
*
|
||||
* comment a.set
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] value Value description
|
||||
*
|
||||
* @return comment for property set return
|
||||
|
@ -60,6 +61,8 @@ EOAPI Eina_Bool efl_canvas_object_simple_a_set(Eo *obj, int value);
|
|||
/**
|
||||
* @brief Common desc for a
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
*
|
||||
* @return Value description
|
||||
*
|
||||
* @ingroup Class_Simple
|
||||
|
@ -73,6 +76,7 @@ EOAPI void efl_canvas_object_simple_b_set(Eo *obj);
|
|||
/**
|
||||
* @brief comment foo
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] a a
|
||||
* @param[in,out] b
|
||||
* @param[out] c
|
||||
|
|
|
@ -88,6 +88,7 @@ EWAPI const Efl_Class *docs_class_get(void);
|
|||
/**
|
||||
* @brief Method documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] a Param documentation.
|
||||
* @param[out] b
|
||||
* @param[out] c Another param documentation.
|
||||
|
@ -105,6 +106,7 @@ EOAPI int docs_meth(Eo *obj, int a, float *b, long *c);
|
|||
*
|
||||
* Set documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] val Value documentation.
|
||||
*
|
||||
* @since 1.18
|
||||
|
@ -118,6 +120,8 @@ EOAPI void docs_prop_set(Eo *obj, int val);
|
|||
*
|
||||
* Get documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
*
|
||||
* @return Value documentation.
|
||||
*
|
||||
* @since 1.18
|
||||
|
|
|
@ -74,6 +74,7 @@ typedef struct _Opaque Opaque;
|
|||
/**
|
||||
* @brief Method documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] a Param documentation.
|
||||
* @param[out] b
|
||||
* @param[out] c Another param documentation.
|
||||
|
@ -91,6 +92,7 @@ EAPI int docs_meth(Docs *obj, int a, float *b, long *c);
|
|||
*
|
||||
* Set documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] val Value documentation.
|
||||
*
|
||||
* @since 1.18
|
||||
|
@ -104,6 +106,8 @@ EAPI void docs_prop_set(Docs *obj, int val);
|
|||
*
|
||||
* Get documentation.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
*
|
||||
* @return Value documentation.
|
||||
*
|
||||
* @since 1.18
|
||||
|
|
|
@ -33,6 +33,7 @@ EWAPI const Efl_Class *struct_class_get(void);
|
|||
/**
|
||||
* @brief Foo docs. This is @c monospace. This is alone-standing $.
|
||||
*
|
||||
* @param[in] obj The object.
|
||||
* @param[in] idx
|
||||
*
|
||||
* @ingroup Struct
|
||||
|
|
Loading…
Reference in New Issue