Cpp: Clarify ownership of provider classes
authorAndre Heinecke <aheinecke@intevation.de>
Wed, 10 Aug 2016 10:04:16 +0000 (12:04 +0200)
committerAndre Heinecke <aheinecke@intevation.de>
Wed, 10 Aug 2016 10:07:56 +0000 (12:07 +0200)
* lang/cpp/src/context.h: Note that the context does not take
ownership of providers.

lang/cpp/src/context.h

index c7c0ecb..70ab079 100644 (file)
@@ -102,9 +102,23 @@ public:
     void addKeyListMode(unsigned int keyListMode);
     unsigned int keyListMode() const;
 
+    /** Set the passphrase provider
+     *
+     * To avoid problems where a class using a context registers
+     * itself as the provider the Context does not take ownership
+     * of the provider and the caller must ensure that the provider
+     * is deleted if it is no longer needed.
+     */
     void setPassphraseProvider(PassphraseProvider *provider);
     PassphraseProvider *passphraseProvider() const;
 
+    /** Set the progress provider
+     *
+     * To avoid problems where a class using a context registers
+     * itself as the provider the Context does not take ownership
+     * of the provider and the caller must ensure that the provider
+     * is deleted if it is no longer needed.
+     */
     void setProgressProvider(ProgressProvider *provider);
     ProgressProvider *progressProvider() const;