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

eolian: better doc

This commit is contained in:
Daniel Kolesa 2014-08-07 16:32:08 +01:00
parent 788386c86c
commit bcf5f1b1dd
1 changed files with 7 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
src/lib/eolian/Eolian.h
View File

@ -1111,13 +1111,19 @@ EAPI Eolian_Expression_Type eolian_expression_eval(const Eolian_Expression *expr
EAPI Eolian_Expression_Type eolian_expression_eval_type(const Eolian_Expression *expr, const Eolian_Type *type, Eina_Value **val);
/*
* @brief Convert the result of expression evaluation to string.
* @brief Convert the result of expression evaluation to a literal as in how
* it would appear in C (e.g. strings are quoted and escaped).
*
* @param[in] v the value.
* @param[in] etp the eolian type of the value.
* @return a stringshare containing the literal (quoted and escaped as needed)
* or NULL.
*
* For e.g. strings this only uses a subset of regular C escape sequences
* so that interoperability is wider than just C (no octal escapes). For
* languages that differ too much, you can write an equivalent function
* using the Eina_Value pointer provided by the eval.
*
* @ingroup Eolian
*/
EAPI Eina_Stringshare *eolian_expression_value_to_literal(const Eina_Value *v, Eolian_Expression_Type etp);