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

See related guidelines in the issue.

include/cef_dom.h

@@ -45,26 +45,26 @@ class CefDOMDocument;
 class CefDOMNode;
 
 ///
-// Interface to implement for visiting the DOM. The methods of this class will
-// be called on the render process main thread.
+/// Interface to implement for visiting the DOM. The methods of this class will
+/// be called on the render process main thread.
 ///
 /*--cef(source=client)--*/
 class CefDOMVisitor : public virtual CefBaseRefCounted {
  public:
   ///
-  // Method executed for visiting the DOM. The document object passed to this
-  // method represents a snapshot of the DOM at the time this method is
-  // executed. DOM objects are only valid for the scope of this method. Do not
-  // keep references to or attempt to access any DOM objects outside the scope
-  // of this method.
+  /// Method executed for visiting the DOM. The document object passed to this
+  /// method represents a snapshot of the DOM at the time this method is
+  /// executed. DOM objects are only valid for the scope of this method. Do not
+  /// keep references to or attempt to access any DOM objects outside the scope
+  /// of this method.
   ///
   /*--cef()--*/
   virtual void Visit(CefRefPtr<CefDOMDocument> document) = 0;
 };
 
 ///
-// Class used to represent a DOM document. The methods of this class should only
-// be called on the render process main thread thread.
+/// Class used to represent a DOM document. The methods of this class should
+/// only be called on the render process main thread thread.
 ///
 /*--cef(source=library)--*/
 class CefDOMDocument : public virtual CefBaseRefCounted {
@@ -72,94 +72,94 @@ class CefDOMDocument : public virtual CefBaseRefCounted {
   typedef cef_dom_document_type_t Type;
 
   ///
-  // Returns the document type.
+  /// Returns the document type.
   ///
   /*--cef(default_retval=DOM_DOCUMENT_TYPE_UNKNOWN)--*/
   virtual Type GetType() = 0;
 
   ///
-  // Returns the root document node.
+  /// Returns the root document node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetDocument() = 0;
 
   ///
-  // Returns the BODY node of an HTML document.
+  /// Returns the BODY node of an HTML document.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetBody() = 0;
 
   ///
-  // Returns the HEAD node of an HTML document.
+  /// Returns the HEAD node of an HTML document.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetHead() = 0;
 
   ///
-  // Returns the title of an HTML document.
+  /// Returns the title of an HTML document.
   ///
   /*--cef()--*/
   virtual CefString GetTitle() = 0;
 
   ///
-  // Returns the document element with the specified ID value.
+  /// Returns the document element with the specified ID value.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetElementById(const CefString& id) = 0;
 
   ///
-  // Returns the node that currently has keyboard focus.
+  /// Returns the node that currently has keyboard focus.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetFocusedNode() = 0;
 
   ///
-  // Returns true if a portion of the document is selected.
+  /// Returns true if a portion of the document is selected.
   ///
   /*--cef()--*/
   virtual bool HasSelection() = 0;
 
   ///
-  // Returns the selection offset within the start node.
+  /// Returns the selection offset within the start node.
   ///
   /*--cef()--*/
   virtual int GetSelectionStartOffset() = 0;
 
   ///
-  // Returns the selection offset within the end node.
+  /// Returns the selection offset within the end node.
   ///
   /*--cef()--*/
   virtual int GetSelectionEndOffset() = 0;
 
   ///
-  // Returns the contents of this selection as markup.
+  /// Returns the contents of this selection as markup.
   ///
   /*--cef()--*/
   virtual CefString GetSelectionAsMarkup() = 0;
 
   ///
-  // Returns the contents of this selection as text.
+  /// Returns the contents of this selection as text.
   ///
   /*--cef()--*/
   virtual CefString GetSelectionAsText() = 0;
 
   ///
-  // Returns the base URL for the document.
+  /// Returns the base URL for the document.
   ///
   /*--cef()--*/
   virtual CefString GetBaseURL() = 0;
 
   ///
-  // Returns a complete URL based on the document base URL and the specified
-  // partial URL.
+  /// Returns a complete URL based on the document base URL and the specified
+  /// partial URL.
   ///
   /*--cef()--*/
   virtual CefString GetCompleteURL(const CefString& partialURL) = 0;
 };
 
 ///
-// Class used to represent a DOM node. The methods of this class should only be
-// called on the render process main thread.
+/// Class used to represent a DOM node. The methods of this class should only be
+/// called on the render process main thread.
 ///
 /*--cef(source=library)--*/
 class CefDOMNode : public virtual CefBaseRefCounted {
@@ -168,110 +168,110 @@ class CefDOMNode : public virtual CefBaseRefCounted {
   typedef cef_dom_node_type_t Type;
 
   ///
-  // Returns the type for this node.
+  /// Returns the type for this node.
   ///
   /*--cef(default_retval=DOM_NODE_TYPE_UNSUPPORTED)--*/
   virtual Type GetType() = 0;
 
   ///
-  // Returns true if this is a text node.
+  /// Returns true if this is a text node.
   ///
   /*--cef()--*/
   virtual bool IsText() = 0;
 
   ///
-  // Returns true if this is an element node.
+  /// Returns true if this is an element node.
   ///
   /*--cef()--*/
   virtual bool IsElement() = 0;
 
   ///
-  // Returns true if this is an editable node.
+  /// Returns true if this is an editable node.
   ///
   /*--cef()--*/
   virtual bool IsEditable() = 0;
 
   ///
-  // Returns true if this is a form control element node.
+  /// Returns true if this is a form control element node.
   ///
   /*--cef()--*/
   virtual bool IsFormControlElement() = 0;
 
   ///
-  // Returns the type of this form control element node.
+  /// Returns the type of this form control element node.
   ///
   /*--cef()--*/
   virtual CefString GetFormControlElementType() = 0;
 
   ///
-  // Returns true if this object is pointing to the same handle as |that|
-  // object.
+  /// Returns true if this object is pointing to the same handle as |that|
+  /// object.
   ///
   /*--cef()--*/
   virtual bool IsSame(CefRefPtr<CefDOMNode> that) = 0;
 
   ///
-  // Returns the name of this node.
+  /// Returns the name of this node.
   ///
   /*--cef()--*/
   virtual CefString GetName() = 0;
 
   ///
-  // Returns the value of this node.
+  /// Returns the value of this node.
   ///
   /*--cef()--*/
   virtual CefString GetValue() = 0;
 
   ///
-  // Set the value of this node. Returns true on success.
+  /// Set the value of this node. Returns true on success.
   ///
   /*--cef()--*/
   virtual bool SetValue(const CefString& value) = 0;
 
   ///
-  // Returns the contents of this node as markup.
+  /// Returns the contents of this node as markup.
   ///
   /*--cef()--*/
   virtual CefString GetAsMarkup() = 0;
 
   ///
-  // Returns the document associated with this node.
+  /// Returns the document associated with this node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMDocument> GetDocument() = 0;
 
   ///
-  // Returns the parent node.
+  /// Returns the parent node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetParent() = 0;
 
   ///
-  // Returns the previous sibling node.
+  /// Returns the previous sibling node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetPreviousSibling() = 0;
 
   ///
-  // Returns the next sibling node.
+  /// Returns the next sibling node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetNextSibling() = 0;
 
   ///
-  // Returns true if this node has child nodes.
+  /// Returns true if this node has child nodes.
   ///
   /*--cef()--*/
   virtual bool HasChildren() = 0;
 
   ///
-  // Return the first child node.
+  /// Return the first child node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetFirstChild() = 0;
 
   ///
-  // Returns the last child node.
+  /// Returns the last child node.
   ///
   /*--cef()--*/
   virtual CefRefPtr<CefDOMNode> GetLastChild() = 0;
@@ -279,52 +279,52 @@ class CefDOMNode : public virtual CefBaseRefCounted {
   // The following methods are valid only for element nodes.
 
   ///
-  // Returns the tag name of this element.
+  /// Returns the tag name of this element.
   ///
   /*--cef()--*/
   virtual CefString GetElementTagName() = 0;
 
   ///
-  // Returns true if this element has attributes.
+  /// Returns true if this element has attributes.
   ///
   /*--cef()--*/
   virtual bool HasElementAttributes() = 0;
 
   ///
-  // Returns true if this element has an attribute named |attrName|.
+  /// Returns true if this element has an attribute named |attrName|.
   ///
   /*--cef()--*/
   virtual bool HasElementAttribute(const CefString& attrName) = 0;
 
   ///
-  // Returns the element attribute named |attrName|.
+  /// Returns the element attribute named |attrName|.
   ///
   /*--cef()--*/
   virtual CefString GetElementAttribute(const CefString& attrName) = 0;
 
   ///
-  // Returns a map of all element attributes.
+  /// Returns a map of all element attributes.
   ///
   /*--cef()--*/
   virtual void GetElementAttributes(AttributeMap& attrMap) = 0;
 
   ///
-  // Set the value for the element attribute named |attrName|. Returns true on
-  // success.
+  /// Set the value for the element attribute named |attrName|. Returns true on
+  /// success.
   ///
   /*--cef()--*/
   virtual bool SetElementAttribute(const CefString& attrName,
                                    const CefString& value) = 0;
 
   ///
-  // Returns the inner text of the element.
+  /// Returns the inner text of the element.
   ///
   /*--cef()--*/
   virtual CefString GetElementInnerText() = 0;
 
   ///
-  // Returns the bounds of the element in device pixels. Use
-  // "window.devicePixelRatio" to convert to/from CSS pixels.
+  /// Returns the bounds of the element in device pixels. Use
+  /// "window.devicePixelRatio" to convert to/from CSS pixels.
   ///
   /*--cef()--*/
   virtual CefRect GetElementBounds() = 0;