commit 7d3c14b3ae91cf926b534cdfc92eb78ca260f344
author Junxiao Shi <git@mail1.yoursunny.com> Sat Aug 05 16:34:39 2017 +0000
committer Junxiao Shi <git@mail1.yoursunny.com> Sat Aug 05 16:34:39 2017 +0000
tree f656a0ced5ae5e0e64b49fdf4302fe6bc79eedd3
parent d2777fa4edfb7d1afc51d121dce2bbc7c64d265b

Refer to TLV-TYPE as "number" instead of "code"

refs #2880

Change-Id: Ie3bd9dc4cb5ca4c3f7aafeed37266adba88b82fb

src/delegation-list.hpp

diff --git a/src/delegation-list.hpp b/src/delegation-list.hpp
index 2a367ba..b9eb6a9 100644
--- a/src/delegation-list.hpp
+++ b/src/delegation-list.hpp
@@ -64,7 +64,7 @@
 
   /** \brief encode into wire format
    *  \param encoder either an EncodingBuffer or an EncodingEstimator
-   *  \param type TLV-TYPE code, either Content (for \p Link) or ForwardingHint
+   *  \param type TLV-TYPE number, either Content (for \p Link) or ForwardingHint
    *  \throw std::invalid_argument \p type is invalid
    *  \throw Error there is no Delegation
    */

src/encoding/tlv.hpp

diff --git a/src/encoding/tlv.hpp b/src/encoding/tlv.hpp
index fbe871f..49d61e5 100644
--- a/src/encoding/tlv.hpp
+++ b/src/encoding/tlv.hpp
@@ -57,6 +57,9 @@
   }
 };
 
+/** @brief TLV-TYPE numbers defined in NDN Packet Format
+ *  @sa https://named-data.net/doc/ndn-tlv/types.html
+ */
 enum {
   Interest      = 5,
   Data          = 6,
@@ -103,11 +106,10 @@
 std::ostream&
 operator<<(std::ostream& os, const SignatureTypeValue& signatureType);
 
-/** @brief TLV codes for SignatureInfo features
+/** @brief TLV-TYPE numbers for SignatureInfo features
  *  @sa docs/tutorials/certificate-format.rst
  */
 enum {
-  // SignatureInfo TLVs
   ValidityPeriod = 253,
   NotBefore = 254,
   NotAfter = 255,
@@ -404,7 +406,7 @@
 {
   uint64_t type = readVarNumber(begin, end);
   if (type > std::numeric_limits<uint32_t>::max()) {
-    BOOST_THROW_EXCEPTION(Error("TLV-TYPE code exceeds allowed maximum"));
+    BOOST_THROW_EXCEPTION(Error("TLV-TYPE number exceeds allowed maximum"));
   }
 
   return static_cast<uint32_t>(type);

src/lp/tlv.hpp

diff --git a/src/lp/tlv.hpp b/src/lp/tlv.hpp
index 0fd782e..5ab1a92 100644
--- a/src/lp/tlv.hpp
+++ b/src/lp/tlv.hpp
@@ -1,5 +1,5 @@
 /* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
-/**
+/*
  * Copyright (c) 2013-2017 Regents of the University of California.
  *
  * This file is part of ndn-cxx library (NDN C++ library with eXperimental eXtensions).
@@ -27,7 +27,7 @@
 namespace tlv {
 
 /**
- * \brief TLV-TYPE code assignments for NDNLPv2
+ * \brief TLV-TYPE numbers for NDNLPv2
  */
 enum {
   LpPacket = 100,