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

See related guidelines in the issue.

include/capi/cef_zip_reader_capi.h

@@ -33,7 +33,7 @@
 // by hand. See the translator.README.txt file in the tools directory for
 // more information.
 //
-// $hash=e16856adecfe81b59b513568b5dcadc851ff07ab$
+// $hash=5e121ff2140e0f1228fd8e2ad632c804ab854210$
 //
 
 #ifndef CEF_INCLUDE_CAPI_CEF_ZIP_READER_CAPI_H_
@@ -48,97 +48,95 @@ extern "C" {
 #endif
 
 ///
-// Structure that supports the reading of zip archives via the zlib unzip API.
-// The functions of this structure should only be called on the thread that
-// creates the object.
+/// Structure that supports the reading of zip archives via the zlib unzip API.
+/// The functions of this structure should only be called on the thread that
+/// creates the object.
 ///
 typedef struct _cef_zip_reader_t {
   ///
-  // Base structure.
+  /// Base structure.
   ///
   cef_base_ref_counted_t base;
 
   ///
-  // Moves the cursor to the first file in the archive. Returns true (1) if the
-  // cursor position was set successfully.
+  /// Moves the cursor to the first file in the archive. Returns true (1) if the
+  /// cursor position was set successfully.
   ///
   int(CEF_CALLBACK* move_to_first_file)(struct _cef_zip_reader_t* self);
 
   ///
-  // Moves the cursor to the next file in the archive. Returns true (1) if the
-  // cursor position was set successfully.
+  /// Moves the cursor to the next file in the archive. Returns true (1) if the
+  /// cursor position was set successfully.
   ///
   int(CEF_CALLBACK* move_to_next_file)(struct _cef_zip_reader_t* self);
 
   ///
-  // Moves the cursor to the specified file in the archive. If |caseSensitive|
-  // is true (1) then the search will be case sensitive. Returns true (1) if the
-  // cursor position was set successfully.
+  /// Moves the cursor to the specified file in the archive. If |caseSensitive|
+  /// is true (1) then the search will be case sensitive. Returns true (1) if
+  /// the cursor position was set successfully.
   ///
   int(CEF_CALLBACK* move_to_file)(struct _cef_zip_reader_t* self,
                                   const cef_string_t* fileName,
                                   int caseSensitive);
 
   ///
-  // Closes the archive. This should be called directly to ensure that cleanup
-  // occurs on the correct thread.
+  /// Closes the archive. This should be called directly to ensure that cleanup
+  /// occurs on the correct thread.
   ///
   int(CEF_CALLBACK* close)(struct _cef_zip_reader_t* self);
 
-  // The below functions act on the file at the current cursor position.
-
   ///
-  // Returns the name of the file.
+  /// Returns the name of the file.
   ///
   // The resulting string must be freed by calling cef_string_userfree_free().
   cef_string_userfree_t(CEF_CALLBACK* get_file_name)(
       struct _cef_zip_reader_t* self);
 
   ///
-  // Returns the uncompressed size of the file.
+  /// Returns the uncompressed size of the file.
   ///
   int64(CEF_CALLBACK* get_file_size)(struct _cef_zip_reader_t* self);
 
   ///
-  // Returns the last modified timestamp for the file.
+  /// Returns the last modified timestamp for the file.
   ///
   cef_basetime_t(CEF_CALLBACK* get_file_last_modified)(
       struct _cef_zip_reader_t* self);
 
   ///
-  // Opens the file for reading of uncompressed data. A read password may
-  // optionally be specified.
+  /// Opens the file for reading of uncompressed data. A read password may
+  /// optionally be specified.
   ///
   int(CEF_CALLBACK* open_file)(struct _cef_zip_reader_t* self,
                                const cef_string_t* password);
 
   ///
-  // Closes the file.
+  /// Closes the file.
   ///
   int(CEF_CALLBACK* close_file)(struct _cef_zip_reader_t* self);
 
   ///
-  // Read uncompressed file contents into the specified buffer. Returns < 0 if
-  // an error occurred, 0 if at the end of file, or the number of bytes read.
+  /// Read uncompressed file contents into the specified buffer. Returns < 0 if
+  /// an error occurred, 0 if at the end of file, or the number of bytes read.
   ///
   int(CEF_CALLBACK* read_file)(struct _cef_zip_reader_t* self,
                                void* buffer,
                                size_t bufferSize);
 
   ///
-  // Returns the current offset in the uncompressed file contents.
+  /// Returns the current offset in the uncompressed file contents.
   ///
   int64(CEF_CALLBACK* tell)(struct _cef_zip_reader_t* self);
 
   ///
-  // Returns true (1) if at end of the file contents.
+  /// Returns true (1) if at end of the file contents.
   ///
   int(CEF_CALLBACK* eof)(struct _cef_zip_reader_t* self);
 } cef_zip_reader_t;
 
 ///
-// Create a new cef_zip_reader_t object. The returned object's functions can
-// only be called from the thread that created the object.
+/// Create a new cef_zip_reader_t object. The returned object's functions can
+/// only be called from the thread that created the object.
 ///
 CEF_EXPORT cef_zip_reader_t* cef_zip_reader_create(
     struct _cef_stream_reader_t* stream);