You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficserver.apache.org by am...@apache.org on 2017/03/08 15:32:17 UTC

[trafficserver] branch master updated: Doc: Fix documentation generation warnings.

This is an automated email from the ASF dual-hosted git repository.

amc pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficserver.git

The following commit(s) were added to refs/heads/master by this push:
       new  a59d57b   Doc: Fix documentation generation warnings.
a59d57b is described below

commit a59d57bae650d6b5f70281dd1c0e65b8aaa784e1
Author: Alan M. Carroll <am...@apache.org>
AuthorDate: Wed Mar 8 09:29:25 2017 -0600

    Doc: Fix documentation generation warnings.
---
 doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst | 2 +-
 doc/developer-guide/api/types/SystemTypes.en.rst          | 5 ++++-
 doc/developer-guide/architecture/architecture.en.rst      | 4 ++--
 doc/developer-guide/architecture/data-structures.en.rst   | 8 ++++----
 4 files changed, 11 insertions(+), 8 deletions(-)

diff --git a/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst b/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
index 0e70c37..710834f 100644
--- a/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
+++ b/doc/developer-guide/api/functions/TSHttpHdrHostGet.en.rst
@@ -39,5 +39,5 @@ header field.
 
 .. note::
 
-   This is much faster than calling :c:func:`TSHttpEffectiveUrlStringGet` and
+   This is much faster than calling :c:func:`TSHttpTxnEffectiveUrlStringGet` and
    extracting the host from the result.
diff --git a/doc/developer-guide/api/types/SystemTypes.en.rst b/doc/developer-guide/api/types/SystemTypes.en.rst
index 4263487..d8ba024 100644
--- a/doc/developer-guide/api/types/SystemTypes.en.rst
+++ b/doc/developer-guide/api/types/SystemTypes.en.rst
@@ -52,4 +52,7 @@ These types are provided by the compiler ("built-in") or from a required operati
 .. cpp:type:: uint8_t
 
    `Reference <https://linux.die.net/include/stdint.h>`__.
-   
\ No newline at end of file
+
+.. cpp:type:: size_t
+
+   `Reference <https://linux.die.net/include/stdint.h>`__.
diff --git a/doc/developer-guide/architecture/architecture.en.rst b/doc/developer-guide/architecture/architecture.en.rst
index 981ef17..ce5d48f 100644
--- a/doc/developer-guide/architecture/architecture.en.rst
+++ b/doc/developer-guide/architecture/architecture.en.rst
@@ -1001,7 +1001,7 @@ the read completes it is checked for validity and if valid, the cache virtual
 connection for it is placed at the front of the write queue for the stripe and
 the write aggregation resumed.
 
-Before doing a write, the method :cpp:func:`Vol::evac_range()` is called to
+Before doing a write, the method :cpp:member:`Vol::evac_range()` is called to
 start an evacuation. If any fragments are found in the buckets in the range the
 earliest such fragment (smallest offset, closest to the write cursor) is
 selected and read from disk and the aggregation buffer write is suspended. The
@@ -1095,7 +1095,7 @@ with overlapping offsets are also coalesced [#coalesced-spans]_. This is all don
    inexplicable feature is provided by the span logic for that module.
 
 After configuration initialization, the cache processor is started by calling
-:cpp:func:`CacheProcessor::start()`. This does a number of things:
+:cpp:member:`CacheProcessor::start()`. This does a number of things:
 
 For each valid span, an instance of :cpp:class:`CacheDisk` is created. This
 class is a :term:`continuation` and so can be used to perform potentially
diff --git a/doc/developer-guide/architecture/data-structures.en.rst b/doc/developer-guide/architecture/data-structures.en.rst
index e63e1c6..dc3e8d7 100644
--- a/doc/developer-guide/architecture/data-structures.en.rst
+++ b/doc/developer-guide/architecture/data-structures.en.rst
@@ -115,11 +115,11 @@ Data Structures
 
       Length of stripe in bytes.
 
-.. cpp:function:: int Vol::evac_range(off_t low, off_t high, int evac_phase)
+   .. cpp:member:: int evac_range(off_t low, off_t high, int evac_phase)
 
-   Start an evacuation if there is any :cpp:class:`EvacuationBlock` in the range
-   from :arg:`low` to :arg:`high`. Return ``0`` if no evacuation was started,
-   non-zero otherwise.
+         Start an evacuation if there is any :cpp:class:`EvacuationBlock` in the range
+         from :arg:`low` to :arg:`high`. Return ``0`` if no evacuation was started,
+         non-zero otherwise.
 
 .. cpp:class:: CacheVol
 

-- 
To stop receiving notification emails like this one, please contact
['"commits@trafficserver.apache.org" <co...@trafficserver.apache.org>'].