X-Git-Url: http://git.droids-corp.org/?p=protos%2Flibecoli.git;a=blobdiff_plain;f=include%2Fecoli.h;fp=include%2Fecoli.h;h=f5c42d294932c1eba149128379675d9f291b4c8b;hp=0000000000000000000000000000000000000000;hb=e18710da81b4c53b357dde2ca55005344edc314f;hpb=31ab7b9ac5570db9da50014abb31adb618218324 diff --git a/include/ecoli.h b/include/ecoli.h new file mode 100644 index 0000000..f5c42d2 --- /dev/null +++ b/include/ecoli.h @@ -0,0 +1,66 @@ +/* SPDX-License-Identifier: BSD-3-Clause + * Copyright 2016, Olivier MATZ + */ + +/** + * @anchor main_page + * @mainpage About Libecoli + * + * This is the C API documentation of libecoli. This library provides + * helpers to build interactive command line interfaces. + * + * To create a command line parser, one should create a @ref + * grammar_tree, which is composed of @ref nodes. Then an input can be + * parsed or completed, respectively using the @ref parse and @ref + * complete APIs. + * + * The library also provides helpers to create a an interactive command + * line based on @ref editline library, and a @ref yaml parser for + * grammar trees. + */ + +#ifndef ECOLI_ +#define ECOLI_ + +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include +#include + +#endif