docs: wrote Doxygen comments for all files
refs: #4118
Change-Id: Ib0e7f1926cdabcca5aa401b59b24519412a099f7
diff --git a/src/tlv/adjacency-lsa.hpp b/src/tlv/adjacency-lsa.hpp
index 217366a..f1854a4 100644
--- a/src/tlv/adjacency-lsa.hpp
+++ b/src/tlv/adjacency-lsa.hpp
@@ -43,7 +43,7 @@
LsaInfo
Adjacency*
- \sa http://redmine.named-data.net/projects/nlsr/wiki/LSDB_DataSet
+ \sa https://redmine.named-data.net/projects/nlsr/wiki/LSDB_DataSet
*/
class AdjacencyLsa
{
@@ -109,13 +109,33 @@
return *this;
}
+ /*! \brief Encodes the Adjacent objects and some info using the method in TAG.
+ *
+ * This function will TLV-format the Adjacent objects and some LSA
+ * info using the implementation speciifed by TAG. Usually this is
+ * called with an estimator first to guess how long the buffer needs
+ * to be, then with an encoder to do the real work. This process is
+ * automated by the other wireEncode.
+ * \sa AdjacencyLsa::wireEncode()
+ */
template<ndn::encoding::Tag TAG>
size_t
wireEncode(ndn::EncodingImpl<TAG>& block) const;
+ /*! \brief Create a TLV encoding of this object.
+ *
+ * Create a block containing the TLV encoding of this object. That
+ * involves two steps: estimating the size that the information will
+ * take up, and then creating a buffer of that size and encoding the
+ * information into it. Both steps are accomplished by
+ * AdjacencyLsa::wireEncode(ndn::EncodingImpl<TAG>&)
+ */
const ndn::Block&
wireEncode() const;
+ /*! \brief Populate this object by decoding the one contained in the
+ * given block.
+ */
void
wireDecode(const ndn::Block& wire);