Customize Sphinx theme

2015-05-19 08:13:13 -07:00
parent 4c1a0303aa
commit 18a55cdb27
83 changed files with 8602 additions and 56 deletions
@@ -0,0 +1,120 @@
+.. cpp:namespace:: fmt
+
+.. _string-formatting-api:
+
+*************
+API Reference
+*************
+
+All functions and classes provided by the C++ Format library reside
+in namespace ``fmt`` and macros have prefix ``FMT_``. For brevity the
+namespace is usually omitted in examples.
+
+Formatting functions
+====================
+
+The following functions use :ref:`format string syntax <syntax>` similar
+to the one used by Python's `str.format
+<http://docs.python.org/3/library/stdtypes.html#str.format>`_ function.
+They take *format_str* and *args* as arguments.
+
+*format_str* is a format string that contains literal text and replacement
+fields surrounded by braces ``{}``. The fields are replaced with formatted
+arguments in the resulting string.
+
+*args* is an argument list representing arbitrary arguments.
+
+.. _format:
+
+.. doxygenfunction:: format(StringRef, ArgList)
+
+.. _print:
+
+.. doxygenfunction:: print(StringRef, ArgList)
+
+.. doxygenfunction:: print(std::FILE*, StringRef, ArgList)
+
+.. doxygenfunction:: print(std::ostream&, StringRef, ArgList)
+
+Printf formatting functions
+===========================
+
+The following functions use `printf format string syntax
+<http://pubs.opengroup.org/onlinepubs/009695399/functions/fprintf.html>`_ with
+a POSIX extension for positional arguments.
+
+.. doxygenfunction:: printf(StringRef, ArgList)
+
+.. doxygenfunction:: fprintf(std::FILE*, StringRef, ArgList)
+
+.. doxygenfunction:: sprintf(StringRef, ArgList)
+
+Write API
+=========
+
+.. doxygenclass:: fmt::BasicWriter
+   :members:
+
+.. doxygenclass:: fmt::BasicMemoryWriter
+   :members:
+
+.. doxygenclass:: fmt::BasicArrayWriter
+   :members:
+
+.. doxygenfunction:: bin
+
+.. doxygenfunction:: oct
+
+.. doxygenfunction:: hex
+
+.. doxygenfunction:: hexu
+
+.. doxygenfunction:: pad(int, unsigned int, Char)
+
+Utilities
+=========
+
+.. doxygendefine:: FMT_VARIADIC
+
+.. doxygenclass:: fmt::ArgList
+   :members:
+
+.. doxygenclass:: fmt::BasicStringRef
+   :members:
+
+.. doxygenclass:: fmt::Buffer
+   :protected-members:
+   :members:
+
+System Errors
+=============
+
+.. doxygenclass:: fmt::SystemError
+   :members:
+
+.. doxygenclass:: fmt::WindowsError
+   :members:
+
+.. _formatstrings:
+
+Custom allocators
+=================
+
+The C++ Format library supports custom dynamic memory allocators.
+A custom allocator class can be specified as a template argument to
+:class:`fmt::BasicMemoryWriter`::
+
+    typedef fmt::BasicMemoryWriter<char, CustomAllocator> CustomMemoryWriter;
+
+It is also possible to write a formatting function that uses a custom
+allocator::
+
+    typedef std::basic_string<char, std::char_traits<char>, CustomAllocator> CustomString;
+
+    CustomString format(CustomAllocator alloc, fmt::StringRef format_str,
+                        fmt::ArgList args) {
+      CustomMemoryWriter writer(alloc);
+      writer.write(format_str, args);
+      return CustomString(writer.data(), writer.size(), alloc);
+    }
+    FMT_VARIADIC(CustomString, format, CustomAllocator, fmt::StringRef)