Browse Source

Comment on destruction of documents

Michael Ragazzon 4 years ago
parent
commit
52017dc82d
2 changed files with 3 additions and 0 deletions
  1. 2 0
      Include/RmlUi/Core/Context.h
  2. 1 0
      Include/RmlUi/Core/ElementDocument.h

+ 2 - 0
Include/RmlUi/Core/Context.h

@@ -106,8 +106,10 @@ public:
 	ElementDocument* LoadDocumentFromMemory(const String& document_rml, const String& source_url = "[document from memory]");
 	ElementDocument* LoadDocumentFromMemory(const String& document_rml, const String& source_url = "[document from memory]");
 	/// Unload the given document.
 	/// Unload the given document.
 	/// @param[in] document The document to unload.
 	/// @param[in] document The document to unload.
+	/// @note The destruction of the document is deferred until the next call to Context::Update().
 	void UnloadDocument(ElementDocument* document);
 	void UnloadDocument(ElementDocument* document);
 	/// Unloads all loaded documents.
 	/// Unloads all loaded documents.
+	/// @note The destruction of the documents is deferred until the next call to Context::Update().
 	void UnloadAllDocuments();
 	void UnloadAllDocuments();
 
 
 	/// Enable or disable handling of the mouse cursor from this context.
 	/// Enable or disable handling of the mouse cursor from this context.

+ 1 - 0
Include/RmlUi/Core/ElementDocument.h

@@ -109,6 +109,7 @@ public:
 	/// Hide the document.
 	/// Hide the document.
 	void Hide();
 	void Hide();
 	/// Close the document.
 	/// Close the document.
+	/// @note The destruction of the document is deferred until the next call to Context::Update().
 	void Close();
 	void Close();
 
 
 	/// Creates the named element.
 	/// Creates the named element.