X-Git-Url: http://git.droids-corp.org/?p=protos%2Flibecoli.git;a=blobdiff_plain;f=include%2Fecoli_node.h;fp=include%2Fecoli_node.h;h=894e64f8fbe146cf64ae9d8142b0f7110e99f47d;hp=acd1daa455a2e29f8ee824934b8dcfd55227ea62;hb=e18710da81b4c53b357dde2ca55005344edc314f;hpb=31ab7b9ac5570db9da50014abb31adb618218324 diff --git a/include/ecoli_node.h b/include/ecoli_node.h index acd1daa..894e64f 100644 --- a/include/ecoli_node.h +++ b/include/ecoli_node.h @@ -3,10 +3,13 @@ */ /** - * Interface to manage the ecoli nodes. + * @defgroup grammar_tree Grammar Tree + * @{ * - * A node is a main structure of the ecoli library, used to define how - * to match and complete the input tokens. A node is a generic object + * @brief Libecoli grammar nodes. + * + * The grammar node is a main structure of the ecoli library, used to define + * how to match and complete the input tokens. A node is a generic object * that implements: * - a parse(node, input) method: check if an input matches * - a complete(node, input) method: return possible completions for @@ -46,6 +49,9 @@ #include #include +/** + * Node has no identifier. + */ #define EC_NO_ID "no-id" #define EC_NODE_ENDLIST ((void *)1) @@ -204,3 +210,5 @@ int ec_node_check_type(const struct ec_node *node, const struct ec_node_type *type); #endif + + /** @} */