Document the need to free vir*Ptr objects

https://bugzilla.redhat.com/show_bug.cgi?id=994731

diff --git a/docs/api.html.in b/docs/api.html.in
index eae7657f09af6f5e90d0dc13c2cbb4ae39ea8f16..68ffa0b022403437df25f78405a0ee4a6d94b9a3 100644 (file)
--- a/docs/api.html.in
+++ b/docs/api.html.in
@@ -159,6 +159,10 @@
         </ul>
       </li>
     </ul>
+    <p>Note: functions returning vir*Ptr (like the virDomainLookup functions)
+    allocate memory which needs to be freed by the caller by the corresponding
+    vir*Free function (e.g. virDomainFree for a virDomainPtr object).
+    </p>
     <p> For more in-depth details of the storage related APIs see
       <a href="storage.html">the storage management page</a>.
     </p>