xo-flatstring: + README + docs + test coverage
This commit is contained in:
parent
75799f4652
commit
a958217c38
26 changed files with 4161 additions and 156 deletions
60
docs/flatstring-class.rst
Normal file
60
docs/flatstring-class.rst
Normal file
|
|
@ -0,0 +1,60 @@
|
|||
.. _flatstring-class:
|
||||
|
||||
Flatstring
|
||||
==========
|
||||
|
||||
.. code-block:: cpp
|
||||
|
||||
#include <xo/flatstring/flatstring.hpp>
|
||||
|
||||
A ``flatstring`` is a thin wrapper around a character array.
|
||||
|
||||
.. doxygenclass:: xo::flatstring
|
||||
|
||||
Instance Variables
|
||||
------------------
|
||||
|
||||
.. doxygengroup:: flatstring-instance-variables
|
||||
:content-only:
|
||||
|
||||
Constants
|
||||
---------
|
||||
|
||||
.. doxygengroup:: flatstring-constants
|
||||
:content-only:
|
||||
|
||||
Constructors
|
||||
------------
|
||||
|
||||
.. doxygengroup:: flatstring-ctor
|
||||
:content-only:
|
||||
|
||||
Properties
|
||||
----------
|
||||
|
||||
.. doxygengroup:: flatstring-properties
|
||||
:content-only:
|
||||
|
||||
Access Methods
|
||||
--------------
|
||||
|
||||
.. doxygengroup:: flatstring-access
|
||||
:content-only:
|
||||
|
||||
Iterators
|
||||
---------
|
||||
|
||||
.. doxygengroup:: flatstring-iterators
|
||||
:content-only:
|
||||
|
||||
Assignment
|
||||
----------
|
||||
|
||||
.. doxygengroup:: flatstring-assign
|
||||
:content-only:
|
||||
|
||||
Conversion
|
||||
----------
|
||||
|
||||
.. doxygengroup:: flatstring-conversion-operators
|
||||
:content-only:
|
||||
Loading…
Add table
Add a link
Reference in a new issue