xo-umbrella2/xo-tokenizer/docs/tokenizer-error-class.rst
Roland Conybeare 6fbfd065a2 xo-tokenizer: docs + error-handling improvement
drop exceptions for return-value error object
2025-06-23 23:08:12 -05:00

52 lines
1.1 KiB
ReStructuredText

.. _tokenizer-error-class
Tokenizer Error
===============
Represent a possible tokenizer error result, including parsing context
Context
-------
.. ditaa::
:--scale: 0.85
+-----------------------------------------+----------+
| tokenizer | |
+-----------------------------------------+ |
| scan_result | |
+-----------------+-----------------------+ buffer |
| token |cBLU tokenizer_error | |
+-----------------+-----------------------+ |
| tokentype | span | |
+-----------------+-----------------------+----------+
.. code-block:: cpp
#include <xo/tokenizer/tokenizer_error.hpp>
Class
------
.. doxygenclass:: xo::scm::tokenizer_error
Instance Variables
------------------
.. doxygengroup:: tokenizer-error-instance-vars
Constructors
------------
.. doxygengroup:: tokenizer-error-ctors
Access Methods
--------------
.. doxygengroup:: tokenizer-error-access-methods
General Methods
---------------
.. doxygengroup:: tokenizer-error-general-methods