Document namespace use.

2014-04-19 19:17:06 -07:00 · 2014-04-19 19:17:06 -07:00 · cdfbd128ec
commit cdfbd128ec
parent 64005c04ac
1 changed files with 4 additions and 0 deletions
--- a/doc/index.rst
+++ b/doc/index.rst
@ -5,6 +5,10 @@
 C++ Format Library API
 ----------------------

+All functions and classes provided by the C++ Format library reside
+in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the
+namespace is often omitted in examples.
+
 .. doxygenfunction:: fmt::Format(StringRef)

 .. doxygenclass:: fmt::BasicWriter