ec_interact_set_desc - Man Page

Set short description of a grammar node.

Synopsis

#include <ecoli/interact.h>

int ec_interact_set_desc(
    struct ec_node   *node,  /* The ec_node on which to add the desc attribute. */
    const char       *desc   /* The short description string. */
);

Description

Set the node attribute EC_INTERACT_DESC_ATTR on the node, containing the given string. It is used by the ec_interact functions to display the short description of the contextual help, overriding the value provided by ec_node_desc().

Return Value

0 on success, or -1 on error.

See Also

ec_interact_get_completions(3), ec_interact_print_helps(3), ec_interact_print_error_helps(3), ec_interact_print_cols(3), ec_interact_set_help(3), ec_interact_append_chars(3), ec_interact_get_callback(3), ec_interact_set_callback(3), ec_interact_get_error_helps(3), ec_interact_free_completions(3), ec_interact_get_helps(3), ec_interact_free_helps(3)

Referenced By

ec_interact_append_chars(3), ec_interact_free_completions(3), ec_interact_free_helps(3), ec_interact_get_callback(3), ec_interact_get_completions(3), ec_interact_get_error_helps(3), ec_interact_get_helps(3), ec_interact_print_cols(3), ec_interact_print_error_helps(3), ec_interact_print_helps(3), ec_interact_set_callback(3), ec_interact_set_help(3).

2026-06-11 Libecoli Programmer's Manual