diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 898ea65d..1763e146 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -4,6 +4,6 @@ xo_doxygen_collect_deps() xo_docdir_doxygen_config() xo_docdir_sphinx_config( index.rst install.rst examples.rst implementation.rst - token-class.rst tokenizer-error-class.rst span-class.rst tokentype-enum.rst - input-state.rst + input-state-class.rst scan-result-class.rst schematika-tokens.rst span-class.rst + token-class-rst tokenizer-error-class.rst tokentype-enum.rst ) diff --git a/docs/README b/docs/README index f29a7b41..ea8a9a25 100644 --- a/docs/README +++ b/docs/README @@ -9,10 +9,10 @@ standalone build | +----------------------+ +------------------------------------------------->| .build/docs/Doxyfile | | +----------------------+ - | | + | ^ + | (cmake | | /------------/ | | - | v | +---------------------------------------+ +-----------------+ +---->| doxygen |--->| .build/docs/dox | | | $PREFIX/share/xo-macros/Doxyfile.in | | +- html/ | @@ -37,3 +37,5 @@ files CMakeLists.txt build entry point conf.py sphinx config _static static files for sphinx + + index.rst toplevel sphinx document; entry point diff --git a/docs/schematika-tokens.rst b/docs/schematika-tokens.rst index 21b4cdad..3d99a7ee 100644 --- a/docs/schematika-tokens.rst +++ b/docs/schematika-tokens.rst @@ -11,5 +11,95 @@ Schematika Tokens - examples - description * - tk_i64 - - 123, -8, + - ``123``, ``-8`` - 64-bit integer literal + * - tk_f64 + - ``1.234``, ``-10``., ``-1.981e-10``, ``3e6`` + - 64-bit floating-point literal + * - tk_string + - ``"hello"``, ``"Q: \"what's up?\"\nA: \"parsing!\""`` + - string literal. Usual escapes ``\n``, ``\r``, ``\t``, ``\"``, ``\\`` + * - tk_symbol + - ``apple``, ``funKy``, ``x123``, ``_mumble``, ``hyphenated-var`` + - symbol name + * - tk_type + - ``type`` + - keyword + * - tk_def + - ``def`` + - keyword + * - tk_lambda + - ``lambda`` + - keyword + * - tk_if + - ``if`` + - keyword + * - tk_let + - ``let`` + - keyword + * - tk_in + - ``in`` + - keyword + * - tk_end + - ``end`` + - keyword + * - tk_leftparen + - ``(`` + - + * - tk_rightparen + - ``)`` + - + * - tl_leftbracket + - ``[`` + - + * - tk_rightbracket + - ``]`` + - + * - tk_leftbrace + - ``{`` + - + * - tk_rightbrace + - ``}`` + - + * - tk_leftangle + - ``<`` + - + * - tk_rightangle + - ``>`` + - + * - tk_dot + - ``.`` + - + * - tk_comma + - ``,`` + - + * - tk_colon + - ``:`` + - + * - tk_doublecolon + - ``::`` + - + * - tk_semicolon + - ``;`` + - + * - tk_singleassign + - ``=`` + - + * - tk_assign + - ``:=`` + - + * - tk_yields + - ``->`` + - + * - tk_plus + - ``+`` + - allowed in symbol + * - tk_minus + - ``-`` + - allowed in symbol + * - tk_star + - ``*`` + - allowed in symbol + * - tk_slash + - ``/`` + - allowed in symbol diff --git a/example/tokenrepl/tokenrepl.cpp b/example/tokenrepl/tokenrepl.cpp index 3b70d435..9afe0059 100644 --- a/example/tokenrepl/tokenrepl.cpp +++ b/example/tokenrepl/tokenrepl.cpp @@ -1,4 +1,4 @@ -/** @file tokenrepl.cp **/ +/** @file tokenrepl.cpp **/ #include "xo/tokenizer/tokenizer.hpp" #include