From 8d89e56d2c69bd5ce2e513b2866e3e534fea9377 Mon Sep 17 00:00:00 2001 From: Victor Zverovich Date: Thu, 18 Dec 2014 08:36:53 -0800 Subject: [PATCH] Set primary domain to cpp --- doc/conf.py | 2 ++ doc/reference.rst | 2 +- format.h | 10 +++++----- 3 files changed, 8 insertions(+), 6 deletions(-) diff --git a/doc/conf.py b/doc/conf.py index a2795b59..5693e2d3 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -106,6 +106,8 @@ pygments_style = 'sphinx' highlight_language = 'c++' +primary_domain = 'cpp' + # A list of ignored prefixes for module index sorting. #modindex_common_prefix = [] diff --git a/doc/reference.rst b/doc/reference.rst index 031fdc47..9cd986d6 100644 --- a/doc/reference.rst +++ b/doc/reference.rst @@ -93,7 +93,7 @@ Custom allocators The C++ Format library supports custom dynamic memory allocators. A custom allocator class can be specified as a template argument to -:cpp:class:`fmt::BasicMemoryWriter`:: +:class:`fmt::BasicMemoryWriter`:: typedef fmt::BasicMemoryWriter CustomMemoryWriter; diff --git a/format.h b/format.h index abbe7097..8c84e441 100644 --- a/format.h +++ b/format.h @@ -1403,7 +1403,7 @@ class SystemError : public internal::RuntimeError { public: /** \rst - Constructs a :cpp:class:`fmt::SystemError` object with the description + Constructs a :class:`fmt::SystemError` object with the description of the form "**: **", where ** is the formatted message and ** is the system message corresponding to the error code. @@ -1422,7 +1422,7 @@ class SystemError : public internal::RuntimeError { \rst This template provides operations for formatting and writing data into a character stream. The output is stored in a buffer provided by a subclass - such as :cpp:class:`fmt::BasicMemoryWriter`. + such as :class:`fmt::BasicMemoryWriter`. You can use one of the following typedefs for common character types: @@ -2041,8 +2041,8 @@ class BasicMemoryWriter : public BasicWriter { #if FMT_USE_RVALUE_REFERENCES /** - Constructs a ``BasicMemoryWriter`` object moving the content of the other - object to it. + Constructs a :class:`fmt::BasicMemoryWriter` object moving the content + of the other object to it. */ BasicMemoryWriter(BasicMemoryWriter &&other) : BasicWriter(buffer_), buffer_(std::move(other.buffer_)) { @@ -2090,7 +2090,7 @@ class WindowsError : public SystemError { public: /** \rst - Constructs a :cpp:class:`fmt::WindowsError` object with the description + Constructs a :class:`fmt::WindowsError` object with the description of the form "**: **", where ** is the formatted message and ** is the system message corresponding to the error code.