Removing references to WireFormat from API docs
This change does require any changes of actual implementation. Specific
language documentation (e.g., doxygen for C++) will include all
necessary specific wire format related parameters and classes.
Change-Id: I51bfdc4a01b6b0de54c88f655f2c9091d1bb35e2
diff --git a/interest.rst b/interest.rst
index 614b354..e40de90 100644
--- a/interest.rst
+++ b/interest.rst
@@ -81,7 +81,7 @@
Interest.wireDecode Method
--------------------------
-Decode the input using a particular wire format and update this Interest.
+Decode the input from wire format and update this Interest.
:[C++]:
@@ -90,7 +90,6 @@
void decode(
const std::vector<uint8_t>& input
- [,WireFormat& wireFormat]
);
@@ -101,7 +100,6 @@
Interest.prototype.decode = function(
input // Uint8Array
- [, wireFormat // WireFormat]
)
@@ -110,40 +108,24 @@
- ``input``
The input byte array to be decoded.
- - ``wireFormat``
- (optional) A WireFormat object used to decode the input. If omitted, use WireFormat getDefaultWireFormat ().
-
Interest.wireEncode Method
--------------------------
-Encode this Interest for a particular wire format.
+Encode this Interest to a wire format.
:[C++]:
.. code-block:: c++
- Blob encode(
-
- [WireFormat& wireFormat]
-
- ) const;
+ Blob encode() const;
:[JavaScript]:
.. code-block:: javascript
// Returns Uint8Array
- Interest.prototype.encode = function(
-
- [wireFormat // WireFormat]
-
- )
-
-:Parameters:
-
- - ``wireFormat``
- (optional) A WireFormat object used to encode the input. If omitted, use use WireFormat getDefaultWireFormat ().
+ Interest.prototype.encode = function()
:Returns: