From e4e7818e274de45c29452dbaff78d02cb86144be Mon Sep 17 00:00:00 2001 From: "Peter D. Barnes, Jr" Date: Wed, 20 May 2020 13:47:38 -0700 Subject: [PATCH] doc: fix sphinx warnings --- doc/manual/source/attributes.rst | 4 ++-- doc/manual/source/tracing.rst | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/doc/manual/source/attributes.rst b/doc/manual/source/attributes.rst index 71af68381..f53c2561a 100644 --- a/doc/manual/source/attributes.rst +++ b/doc/manual/source/attributes.rst @@ -466,10 +466,10 @@ and a single :cpp:class:`PointToPointNetDevice` (``net0``), added a :cpp:class:`DropTailQueue` (``q``) to ``net0``, which will be configured with a queue size limit of 80 packets. -As a final note, the :cpp:func:`Config::Set...()` functions +As a final note, the `Config::Set...()` functions will throw an error if the targeted Attribute does not exist at the path given. There are also "fail-safe" versions, -:cpp:func:`Config::Set...FailSafe()`, if you can't be sure the Attribute +`Config::Set...FailSafe()`, if you can't be sure the Attribute exists. The fail-safe versions return `true` if at least one instance could be set. diff --git a/doc/manual/source/tracing.rst b/doc/manual/source/tracing.rst index 76f6b58d7..225bb753f 100644 --- a/doc/manual/source/tracing.rst +++ b/doc/manual/source/tracing.rst @@ -294,10 +294,10 @@ congestion window in the TCP socket, the registered callback will be executed and the function ``CwndTracer`` will be called printing out the old and new values of the TCP congestion window. -As a final note, the :cpp:func:`Config::Connect...()` functions +As a final note, the `Config::Connect...()` functions will throw an error if the targeted TraceSource does not exist at the path given. There are also "fail-safe" versions, -:cpp:func:`Config::Connect...FailSafe()`, if you can't be sure the TraceSource +`Config::Connect...FailSafe()`, if you can't be sure the TraceSource exists. The fail-safe versions return `true` if at least one connection could be made.