aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorVictor Zverovich <viz@fb.com>2020-07-19 09:51:52 -0700
committerVictor Zverovich <viz@fb.com>2020-07-19 09:51:52 -0700
commite2837084eee731cfdfc542004c706b739b67d33f (patch)
tree56dede036605b19062a123ad6f941f7ffcd9da2e /doc
parent9f0c0033712cf29789a84550ec2357a1c49ea08d (diff)
downloadfmtlib-e2837084eee731cfdfc542004c706b739b67d33f.tar.gz
Add a color section
Diffstat (limited to 'doc')
-rw-r--r--doc/api.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/doc/api.rst b/doc/api.rst
index 49cc5537..f4ea0ec7 100644
--- a/doc/api.rst
+++ b/doc/api.rst
@@ -15,6 +15,7 @@ The {fmt} library API consists of the following parts:
and tuples
* :ref:`fmt/chrono.h <chrono-api>`: date and time formatting
* :ref:`fmt/compile.h <compile-api>`: format string compilation
+* :ref:`fmt/color.h <color-api>`: terminal color and text style
* :ref:`fmt/ostream.h <ostream-api>`: ``std::ostream`` support
* :ref:`fmt/printf.h <printf-api>`: ``printf`` formatting
@@ -400,6 +401,15 @@ bottleneck.
.. doxygendefine:: FMT_COMPILE
+.. _color-api:
+
+Terminal color and text style
+=============================
+
+``fmt/color.h`` provides support for terminal color and text style output.
+
+.. doxygenfunction:: print(const text_style&, const S&, const Args&...)
+
.. _ostream-api:
``std::ostream`` Support