kimcinoo
/
efl
forked from enlightenment/efl
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

eolian: properly add < in struct/enum field docs 

Fixes T4443.
This commit is contained in:
Daniel Kolesa 2016-09-09 13:04:04 +02:00
parent cfcdacc5f7
commit dd9155cf24
3 changed files with 16 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
src/bin/eolian/docs_generator.c
View File

@ -281,7 +281,10 @@ _gen_doc_brief(const char *summary, const char *since, const char *group,
{
int curl = 4 + indent;
Eina_Strbuf *wbuf = eina_strbuf_new();
eina_strbuf_append(buf, "/** ");
if (indent)
eina_strbuf_append(buf, "/**< ");
else
eina_strbuf_append(buf, "/** ");
curl = _append_section(summary, indent, curl, buf, wbuf, use_legacy);
eina_strbuf_free(wbuf);
curl = _append_extra(el, indent, curl, EINA_FALSE, buf);
@ -309,7 +312,10 @@ _gen_doc_full(const char *summary, const char *description, const char *since,
{
int curl = 0;
Eina_Strbuf *wbuf = eina_strbuf_new();
eina_strbuf_append(buf, "/**\n");
if (indent)
eina_strbuf_append(buf, "/**<\n");
else
eina_strbuf_append(buf, "/**\n");
curl += _indent_line(buf, indent);
eina_strbuf_append(buf, " * @brief ");
curl += sizeof(" * @brief ") - 1;

8
src/tests/eolian/data/docs_ref.h
View File

@ -29,9 +29,9 @@ typedef Eo Docs;
*/
typedef struct _Foo
{
int field1; /** Field documentation. */
int field1; /**< Field documentation. */
float field2;
short field3; /** Another field documentation. */
short field3; /**< Another field documentation. */
} Foo;
/** Docs for enum Bar.
@ -41,8 +41,8 @@ typedef struct _Foo
typedef enum
{
BAR_BLAH = 0,
BAR_FOO = 1, /** Docs for foo. */
BAR_BAR = 2 /** Docs for bar. */
BAR_FOO = 1, /**< Docs for foo. */
BAR_BAR = 2 /**< Docs for bar. */
} Bar;
/**

8
src/tests/eolian/data/docs_ref_legacy.h
View File

@ -29,9 +29,9 @@ typedef Eo Docs;
*/
typedef struct _Foo
{
int field1; /** Field documentation. */
int field1; /**< Field documentation. */
float field2;
short field3; /** Another field documentation. */
short field3; /**< Another field documentation. */
} Foo;
/** Docs for enum Bar.
@ -41,8 +41,8 @@ typedef struct _Foo
typedef enum
{
BAR_BLAH = 0,
BAR_FOO = 1, /** Docs for foo. */
BAR_BAR = 2 /** Docs for bar. */
BAR_FOO = 1, /**< Docs for foo. */
BAR_BAR = 2 /**< Docs for bar. */
} Bar;
/**