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/data.rst b/data.rst
index 6ce1cab..2f48325 100644
--- a/data.rst
+++ b/data.rst
@@ -94,7 +94,7 @@
Data.wireDecode Method
----------------------
-Decode the input using a particular wire format and update this Data. If wireFormat is the default wire format, also set the defaultWireEncoding field to the input.
+Decode the input from wire format and update this Data.
:[C++]:
@@ -103,7 +103,6 @@
void wireDecode(
const std::vector<uint8_t>& input
- [, WireFormat& wireFormat]
);
@@ -114,7 +113,6 @@
ContentObject.prototype.decode = function(
input // Uint8Array
- [, wireFormat // WireFormat]
)
@@ -123,39 +121,23 @@
- ``input``
The input byte array to be decoded.
- - ``wireFormat``
- (optional) A WireFormat object used to decode the input. If omitted, use WireFormat getDefaultWireFormat().
-
Data.wireEncode Method
----------------------
-Encode this Data for a particular wire format. If wireFormat is the default wire format, also set the defaultWireEncoding field to the encoded result.
+Encode this Data to wire format.
:[C++]:
.. code-block:: c++
- SignedBlob wireEncode(
-
- [WireFormat& wireFormat]
-
- ) const;
+ SignedBlob wireEncode() const;
:[JavaScript]:
.. code-block:: javascript
// Returns Uint8Array
- ContentObject.prototype.encode = function(
-
- [wireFormat // WireFormat]
-
- )
-
-:Parameters:
-
- - wireFormat
- (optional) A WireFormat object used to encode the input. If omitted, use WireFormat getDefaultWireFormat ().
+ ContentObject.prototype.encode = function()
:Returns: