Add comment for cross origion whitelist methods

CefView · Aug 14, 2023 · 0b3000a · 0b3000a
1 parent 982eb4e
commit 0b3000a
Showing 1 changed file with 11 additions and 10 deletions.
diff --git a/include/QCefContext.h b/include/QCefContext.h
@@ -88,25 +88,26 @@ class QCEFVIEW_EXPORT QCefContext : public QObject
   bool deleteAllCookies();
 
   /// <summary>
-  /// Adds an entry to the cross-origin access whitelist.
+  /// Adds an entry to the cross-origin access whitelist. For details please refer to:
+  /// https://github.com/chromiumembedded/cef/blob/605c2bac86415dcec1e2902cdc46dc11c1ad026a/include/cef_origin_whitelist.h#L81C23-L81C23
   /// </summary>
-  /// <param name="sourceOrigin"></param>
-  /// <param name="targetSchema"></param>
-  /// <param name="targetDomain"></param>
-  /// <param name="allowTargetSubdomains"></param>
+  /// <param name="sourceOrigin">The source origin</param>
+  /// <param name="targetSchema">The target schema</param>
+  /// <param name="targetDomain">The target domain</param>
+  /// <param name="allowTargetSubdomains">Whether to allow subdomain or not</param>
   /// <returns>True on success; otherwise false</returns>
   bool addCrossOriginWhitelistEntry(const QString& sourceOrigin,
                                     const QString& targetSchema,
                                     const QString& targetDomain,
                                     bool allowTargetSubdomains);
 
   /// <summary>
-  /// Removes an entry from the cross-origin access whitelist.
+  /// Removes an entry from the cross-origin access whitelist. For details please refer to:
+  /// https://github.com/chromiumembedded/cef/blob/605c2bac86415dcec1e2902cdc46dc11c1ad026a/include/cef_origin_whitelist.h#L91C12-L91C12
   /// </summary>
-  /// <param name="sourceOrigin"></param>
-  /// <param name="targetSchema"></param>
-  /// <param name="targetDomain"></param>
-  /// <param name="allowTargetSubdomains"></param>
+  /// <param name="sourceOrigin">The source origin</param>
+  /// <param name="targetSchema">The target schema</param>
+  /// <param name="targetDomain">The target domain</param>
   /// <returns>True on success; otherwise false</returns>
   bool removeCrossOriginWhitelistEntry(const QString& sourceOrigin,
                                        const QString& targetSchema,