From c0d371aa94cbd0792686a7070107190e7d701acf Mon Sep 17 00:00:00 2001
From: Christian Mollekopf <chrigi_1@fastmail.fm>
Date: Tue, 2 Feb 2016 14:54:05 +0100
Subject: Docs

---
 common/domaintypeadaptorfactoryinterface.h | 6 ++++++
 1 file changed, 6 insertions(+)

(limited to 'common')

diff --git a/common/domaintypeadaptorfactoryinterface.h b/common/domaintypeadaptorfactoryinterface.h
index d974bbf..4d0ce04 100644
--- a/common/domaintypeadaptorfactoryinterface.h
+++ b/common/domaintypeadaptorfactoryinterface.h
@@ -38,5 +38,11 @@ public:
     typedef QSharedPointer<DomainTypeAdaptorFactoryInterface> Ptr;
     virtual ~DomainTypeAdaptorFactoryInterface() {};
     virtual QSharedPointer<Sink::ApplicationDomain::BufferAdaptor> createAdaptor(const Sink::Entity &entity) = 0;
+
+    /*
+     * Creates a buffer from @param domainType
+     *
+     * Note that this only serialized parameters that are part of ApplicationDomainType::changedProperties()
+     */
     virtual void createBuffer(const Sink::ApplicationDomain::ApplicationDomainType &domainType, flatbuffers::FlatBufferBuilder &fbb, void const *metadataData = 0, size_t metadataSize = 0) = 0;
 };
-- 
cgit v1.2.3