Changeset 31915 in vbox for trunk/src/VBox/Additions

Timestamp:

Aug 24, 2010 12:20:32 PM (15 years ago)

Author:

vboxsync

svn:sync-xref-src-repo-rev:

65125

Message:

Comments.

File:

• trunk/src/VBox/Additions/common/VBoxService/VBoxServicePropCache.cpp (modified) (3 diffs)

trunk/src/VBox/Additions/common/VBoxService/VBoxServicePropCache.cpp

@@ -141 +141 @@
 
 
-/** @todo Docs */
+/**
+ * Updates a cache entry without submitting any changes to the host.
+ * This is handy for defining default values/flags.
+ *
+ * @returns VBox status code.
+ *
+ * @param   pCache          The property cache.
+ * @param   pszName         The property name.
+ * @param   fFlags          The property flags to set.
+ * @param   pszValueReset   The property reset value.
+ */
 int VBoxServicePropCacheUpdateEntry(PVBOXSERVICEVEPROPCACHE pCache,
                                     const char *pszName, uint32_t fFlags, const char *pszValueReset)
@@ -176 +186 @@
  * Updates the local guest property cache and writes it to HGCM if outdated.
  *
- * @returns VBox status code. Errors will be logged.
+ * @returns VBox status code.
  *
  * @param   pCache          The property cache.
@@ -209 +219 @@
  * @param   pCache          The property cache.
  * @param   pszName         The property name.
+ * @param   fFlags          The property flags to set.
+ * @param   pszValueReset   The property reset value.
  * @param   pszValueFormat  The property format string.  If this is NULL then
  *                          the property will be deleted (if possible).