diff options
author | Henning Baldersheim <balder@oath.com> | 2018-06-14 23:19:06 +0200 |
---|---|---|
committer | Henning Baldersheim <balder@oath.com> | 2018-06-14 23:19:06 +0200 |
commit | e4456bfbc2367e22ae0b38af28e14b1f80088cd3 (patch) | |
tree | d1780d5afc20ea5be8841df947ac27486b7aba8a /document | |
parent | 9c995cacfe8772cf5b8e617cb47abee2fbd077c6 (diff) |
Update comments
Diffstat (limited to 'document')
5 files changed, 7 insertions, 17 deletions
diff --git a/document/src/vespa/document/update/addvalueupdate.cpp b/document/src/vespa/document/update/addvalueupdate.cpp index d72c12dd26c..051ffcf8b2a 100644 --- a/document/src/vespa/document/update/addvalueupdate.cpp +++ b/document/src/vespa/document/update/addvalueupdate.cpp @@ -5,7 +5,6 @@ #include <vespa/document/fieldvalue/fieldvalues.h> #include <vespa/document/serialization/vespadocumentdeserializer.h> #include <vespa/document/util/serializableexceptions.h> -#include <vespa/document/util/bytebuffer.h> #include <vespa/vespalib/objects/nbostream.h> #include <vespa/vespalib/util/xmlstream.h> diff --git a/document/src/vespa/document/update/documentupdate.h b/document/src/vespa/document/update/documentupdate.h index b27047e98a2..12ad9705459 100644 --- a/document/src/vespa/document/update/documentupdate.h +++ b/document/src/vespa/document/update/documentupdate.h @@ -58,14 +58,6 @@ public: static DocumentUpdate::UP createHEAD(const DocumentTypeRepo & repo, vespalib::nbostream stream); static DocumentUpdate::UP createHEAD(const DocumentTypeRepo & repo, ByteBuffer & buffer); - /** - * Create a document update from a byte buffer containing a serialized - * document update. Public to allow useage in std::make_unique/shared. - * - * @param repo Document type repo used to find proper document type - * @param buffer The buffer containing the serialized document update - * @param serializeVersion Selector between serialization formats. - */ DocumentUpdate(); /** * The document type is not strictly needed, as we know this at applyTo() diff --git a/document/src/vespa/document/update/fieldupdate.h b/document/src/vespa/document/update/fieldupdate.h index 9d0b9feabce..6bd46c3a172 100644 --- a/document/src/vespa/document/update/fieldupdate.h +++ b/document/src/vespa/document/update/fieldupdate.h @@ -40,9 +40,9 @@ public: /** * This is a convenience function to construct a field update directly from - * a byte buffer by deserializing all its content from the buffer. + * a stream by deserializing all its content from the stream. * - * @param type A document type that describes the buffer content. + * @param type A document type that describes the stream content. * @param stream A stream that contains a serialized field update. */ FieldUpdate(const DocumentTypeRepo& repo, const DataType & type, nbostream & stream); @@ -75,10 +75,10 @@ public: void printXml(XmlOutputStream&) const override; /** - * Deserializes the given byte buffer into an instance of an update object. + * Deserializes the given stream into an instance of an update object. * Not a Deserializable, as document type is needed as extra information. * - * @param type A document type that describes the buffer content. + * @param type A document type that describes the stream content. * @param buffer The stream that contains the serialized update object. */ void deserialize(const DocumentTypeRepo& repo, const DocumentType& type, nbostream& stream); diff --git a/document/src/vespa/document/update/valueupdate.cpp b/document/src/vespa/document/update/valueupdate.cpp index 2fe203d8d4b..6b893a80fd0 100644 --- a/document/src/vespa/document/update/valueupdate.cpp +++ b/document/src/vespa/document/update/valueupdate.cpp @@ -9,7 +9,6 @@ namespace document { IMPLEMENT_IDENTIFIABLE_ABSTRACT(ValueUpdate, Identifiable); -// Create a value update from a byte buffer. std::unique_ptr<ValueUpdate> ValueUpdate::createInstance(const DocumentTypeRepo& repo, const DataType& type, nbostream & stream) { diff --git a/document/src/vespa/document/update/valueupdate.h b/document/src/vespa/document/update/valueupdate.h index 80afe39d132..963e1ad1d96 100644 --- a/document/src/vespa/document/update/valueupdate.h +++ b/document/src/vespa/document/update/valueupdate.h @@ -39,7 +39,7 @@ public: using CP = vespalib::CloneablePtr<ValueUpdate>; /** - * Create a value update object from the given byte buffer. + * Create a value update object from the given stream. * * @param type A data type that describes the content of the buffer. * @param buffer The stream that containes the serialized update. @@ -82,9 +82,9 @@ public: ValueUpdate* clone() const override = 0; /** - * Deserializes the given byte buffer into an instance of an update object. + * Deserializes the given stream into an instance of an update object. * - * @param type A data type that describes the content of the buffer. + * @param type A data type that describes the content of the stream. * @param buffer The stream that contains the serialized update object. */ virtual void deserialize(const DocumentTypeRepo& repo, const DataType& type, nbostream & stream) = 0; |