bcarrella/cef
1
0
Fork 0
mirror of https://bitbucket.org/chromiumembedded/cef synced 2025-06-05 21:39:12 +02:00
Code Issues Packages Projects Releases Wiki Activity

Update include/ comments to Doxygen formatting (see issue #3384)

Browse Source 
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
2022-08-31 22:03:04 -04:00
parent 7b352159df
commit d7a153bdd4
235 changed files with 11484 additions and 11274 deletions
Download Patch File Download Diff File Expand all files Collapse all files

98
include/wrapper/cef_xml_object.h
View File

@ -48,27 +48,25 @@
class CefStreamReader;
///
// Thread safe class for representing XML data as a structured object. This
// class should not be used with large XML documents because all data will be
// resident in memory at the same time. This implementation supports a
// restricted set of XML features:
// <pre>
// (1) Processing instructions, whitespace and comments are ignored.
// (2) Elements and attributes must always be referenced using the fully
// qualified name (ie, namespace:localname).
// (3) Empty elements (<a/>) and elements with zero-length values (<a></a>)
// are considered the same.
// (4) Element nodes are considered part of a value if:
// (a) The element node follows a non-element node at the same depth
// (see 5), or
// (b) The element node does not have a namespace and the parent node does.
// (5) Mixed node types at the same depth are combined into a single element
// value as follows:
// (a) All node values are concatenated to form a single string value.
// (b) Entity reference nodes are resolved to the corresponding entity
// value.
// (c) Element nodes are represented by their outer XML string.
// </pre>
/// Thread safe class for representing XML data as a structured object. This
/// class should not be used with large XML documents because all data will be
/// resident in memory at the same time. This implementation supports a
/// restricted set of XML features:
///
/// 1. Processing instructions, whitespace and comments are ignored.
/// 2. Elements and attributes must always be referenced using the fully
/// qualified name (ie, namespace:localname).
/// 3. Empty elements ("<a/>") and elements with zero-length values ("<a></a>")
/// are considered the same.
/// 4. Element nodes are considered part of a value if:
/// 1. The element node follows a non-element node at the same depth
/// (see 5), or
/// 2. The element node does not have a namespace and the parent node does.
/// 5. Mixed node types at the same depth are combined into a single element
/// value as follows:
/// 1. All node values are concatenated to form a single string value.
/// 2. Entity reference nodes are resolved to the corresponding entity value.
/// 3. Element nodes are represented by their outer XML string.
///
class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
public:
@ -76,8 +74,8 @@ class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
using AttributeMap = std::map<CefString, CefString>;
///
// Create a new object with the specified name. An object name must always be
// at least one character long.
/// Create a new object with the specified name. An object name must always be
/// at least one character long.
///
explicit CefXmlObject(const CefString& name);
@ -85,8 +83,8 @@ class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
CefXmlObject& operator=(const CefXmlObject&) = delete;
///
// Load the contents of the specified XML stream into this object. The
// existing children and attributes, if any, will first be cleared.
/// Load the contents of the specified XML stream into this object. The
/// existing children and attributes, if any, will first be cleared.
///
bool Load(CefRefPtr<CefStreamReader> stream,
CefXmlReader::EncodingType encodingType,
@ -94,56 +92,56 @@ class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
CefString* loadError);
///
// Set the name, children and attributes of this object to a duplicate of the
// specified object's contents. The existing children and attributes, if any,
// will first be cleared.
/// Set the name, children and attributes of this object to a duplicate of the
/// specified object's contents. The existing children and attributes, if any,
/// will first be cleared.
///
void Set(CefRefPtr<CefXmlObject> object);
///
// Append a duplicate of the children and attributes of the specified object
// to this object. If |overwriteAttributes| is true then any attributes in
// this object that also exist in the specified object will be overwritten
// with the new values. The name of this object is not changed.
/// Append a duplicate of the children and attributes of the specified object
/// to this object. If |overwriteAttributes| is true then any attributes in
/// this object that also exist in the specified object will be overwritten
/// with the new values. The name of this object is not changed.
///
void Append(CefRefPtr<CefXmlObject> object, bool overwriteAttributes);
///
// Return a new object with the same name, children and attributes as this
// object. The parent of the new object will be NULL.
/// Return a new object with the same name, children and attributes as this
/// object. The parent of the new object will be NULL.
///
CefRefPtr<CefXmlObject> Duplicate();
///
// Clears this object's children and attributes. The name and parenting of
// this object are not changed.
/// Clears this object's children and attributes. The name and parenting of
/// this object are not changed.
///
void Clear();
///
// Access the object's name. An object name must always be at least one
// character long.
/// Access the object's name. An object name must always be at least one
/// character long.
///
CefString GetName();
bool SetName(const CefString& name);
///
// Access the object's parent. The parent can be NULL if this object has not
// been added as the child on another object.
/// Access the object's parent. The parent can be NULL if this object has not
/// been added as the child on another object.
///
bool HasParent();
CefRefPtr<CefXmlObject> GetParent();
///
// Access the object's value. An object cannot have a value if it also has
// children. Attempting to set the value while children exist will fail.
/// Access the object's value. An object cannot have a value if it also has
/// children. Attempting to set the value while children exist will fail.
///
bool HasValue();
CefString GetValue();
bool SetValue(const CefString& value);
///
// Access the object's attributes. Attributes must have unique names.
/// Access the object's attributes. Attributes must have unique names.
///
bool HasAttributes();
size_t GetAttributeCount();
@ -154,11 +152,11 @@ class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
void ClearAttributes();
///
// Access the object's children. Each object can only have one parent so
// attempting to add an object that already has a parent will fail. Removing a
// child will set the child's parent to NULL. Adding a child will set the
// child's parent to this object. This object's value, if any, will be cleared
// if a child is added.
/// Access the object's children. Each object can only have one parent so
/// attempting to add an object that already has a parent will fail. Removing
/// a child will set the child's parent to NULL. Adding a child will set the
/// child's parent to this object. This object's value, if any, will be
/// cleared if a child is added.
///
bool HasChildren();
size_t GetChildCount();
@ -169,12 +167,12 @@ class CefXmlObject : public base::RefCountedThreadSafe<CefXmlObject> {
void ClearChildren();
///
// Find the first child with the specified name.
/// Find the first child with the specified name.
///
CefRefPtr<CefXmlObject> FindChild(const CefString& name);
///
// Find all children with the specified name.
/// Find all children with the specified name.
///
size_t FindChildren(const CefString& name, ObjectVector& children);