capi: Update list comments in generated files

This commit is contained in:
Sergey Markelov 2024-01-05 14:53:36 -05:00 committed by Marshall Greenblatt
parent 9f6995f839
commit deb4664038
11 changed files with 69 additions and 74 deletions

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=5f808dd18e66966b62a3b8980075e87a5109e23f$ // $hash=fc6fbee765ce2b649f5293c8c4b076d36014e4aa$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_FRAME_HANDLER_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_FRAME_HANDLER_CAPI_H_
@ -53,48 +53,41 @@ extern "C" {
/// The order of callbacks is: /// The order of callbacks is:
/// ///
/// (1) During initial cef_browser_host_t creation and navigation of the main /// (1) During initial cef_browser_host_t creation and navigation of the main
/// frame: - cef_frame_handler_t::OnFrameCreated => The initial main frame /// frame:
/// object has been /// - cef_frame_handler_t::OnFrameCreated => The initial main frame object has
/// created. Any commands will be queued until the frame is attached. /// been created. Any commands will be queued until the frame is attached.
/// - cef_frame_handler_t::OnMainFrameChanged => The initial main frame object /// - cef_frame_handler_t::OnMainFrameChanged => The initial main frame object
/// has /// has been assigned to the browser.
/// been assigned to the browser.
/// - cef_life_span_handler_t::OnAfterCreated => The browser is now valid and /// - cef_life_span_handler_t::OnAfterCreated => The browser is now valid and
/// can be /// can be used.
/// used.
/// - cef_frame_handler_t::OnFrameAttached => The initial main frame object is /// - cef_frame_handler_t::OnFrameAttached => The initial main frame object is
/// now /// now connected to its peer in the renderer process. Commands can be routed.
/// connected to its peer in the renderer process. Commands can be routed.
/// ///
/// (2) During further cef_browser_host_t navigation/loading of the main frame /// (2) During further cef_browser_host_t navigation/loading of the main frame
/// and/or sub-frames: /// and/or sub-frames:
/// - cef_frame_handler_t::OnFrameCreated => A new main frame or sub-frame /// - cef_frame_handler_t::OnFrameCreated => A new main frame or sub-frame
/// object /// object has been created. Any commands will be queued until the frame is
/// has been created. Any commands will be queued until the frame is attached. /// attached.
/// - cef_frame_handler_t::OnFrameAttached => A new main frame or sub-frame /// - cef_frame_handler_t::OnFrameAttached => A new main frame or sub-frame
/// object /// object is now connected to its peer in the renderer process. Commands can
/// is now connected to its peer in the renderer process. Commands can be /// be routed.
/// routed.
/// - cef_frame_handler_t::OnFrameDetached => An existing main frame or sub- /// - cef_frame_handler_t::OnFrameDetached => An existing main frame or sub-
/// frame /// frame object has lost its connection to the renderer process. If multiple
/// object has lost its connection to the renderer process. If multiple
/// objects are detached at the same time then notifications will be sent for /// objects are detached at the same time then notifications will be sent for
/// any sub-frame objects before the main frame object. Commands can no longer /// any sub-frame objects before the main frame object. Commands can no longer
/// be routed and will be discarded. /// be routed and will be discarded.
/// - cef_frame_handler_t::OnMainFrameChanged => A new main frame object has /// - cef_frame_handler_t::OnMainFrameChanged => A new main frame object has
/// been /// been assigned to the browser. This will only occur with cross-origin
/// assigned to the browser. This will only occur with cross-origin navigation /// navigation or re-navigation after renderer process termination (due to
/// or re-navigation after renderer process termination (due to crashes, etc). /// crashes, etc).
/// ///
/// (3) During final cef_browser_host_t destruction of the main frame: - /// (3) During final cef_browser_host_t destruction of the main frame:
/// cef_frame_handler_t::OnFrameDetached => Any sub-frame objects have lost /// - cef_frame_handler_t::OnFrameDetached => Any sub-frame objects have lost
/// their /// their connection to the renderer process. Commands can no longer be routed
/// connection to the renderer process. Commands can no longer be routed and /// and will be discarded.
/// will be discarded.
/// - cef_life_span_handler_t::OnBeforeClose => The browser has been destroyed. /// - cef_life_span_handler_t::OnBeforeClose => The browser has been destroyed.
/// - cef_frame_handler_t::OnFrameDetached => The main frame object have lost /// - cef_frame_handler_t::OnFrameDetached => The main frame object have lost
/// its /// its connection to the renderer process. Notifications will be sent for any
/// connection to the renderer process. Notifications will be sent for any
/// sub-frame objects before the main frame object. Commands can no longer be /// sub-frame objects before the main frame object. Commands can no longer be
/// routed and will be discarded. /// routed and will be discarded.
/// - cef_frame_handler_t::OnMainFrameChanged => The final main frame object has /// - cef_frame_handler_t::OnMainFrameChanged => The final main frame object has
@ -111,7 +104,7 @@ extern "C" {
/// will then be discarded after the real cross-origin sub-frame is created in /// will then be discarded after the real cross-origin sub-frame is created in
/// the new/target renderer process. The client will receive cross-origin /// the new/target renderer process. The client will receive cross-origin
/// navigation callbacks (2) for the transition from the temporary sub-frame to /// navigation callbacks (2) for the transition from the temporary sub-frame to
/// the real sub-frame. The temporary sub-frame will not recieve or execute /// the real sub-frame. The temporary sub-frame will not receive or execute
/// commands during this transitional period (any sent commands will be /// commands during this transitional period (any sent commands will be
/// discarded). /// discarded).
/// ///
@ -119,7 +112,7 @@ extern "C" {
/// browser, a temporary main frame object for the popup will first be created /// browser, a temporary main frame object for the popup will first be created
/// in the parent's renderer process. That temporary main frame will then be /// in the parent's renderer process. That temporary main frame will then be
/// discarded after the real cross-origin main frame is created in the /// discarded after the real cross-origin main frame is created in the
/// new/target renderer process. The client will recieve creation and initial /// new/target renderer process. The client will receive creation and initial
/// navigation callbacks (1) for the temporary main frame, followed by cross- /// navigation callbacks (1) for the temporary main frame, followed by cross-
/// origin navigation callbacks (2) for the transition from the temporary main /// origin navigation callbacks (2) for the transition from the temporary main
/// frame to the real main frame. The temporary main frame may receive and /// frame to the real main frame. The temporary main frame may receive and

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=5f2f1d43cf93b10ba58b2aa2716bc3638e58c97c$ // $hash=54edf9e9c2a12acdc4cab55079a4a5cb8e2a1e43$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_LIFE_SPAN_HANDLER_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_LIFE_SPAN_HANDLER_CAPI_H_
@ -138,7 +138,7 @@ typedef struct _cef_life_span_handler_t {
struct _cef_browser_t* browser); struct _cef_browser_t* browser);
/// ///
/// Called when a browser has recieved a request to close. This may result /// Called when a browser has received a request to close. This may result
/// directly from a call to cef_browser_host_t::*close_browser() or indirectly /// directly from a call to cef_browser_host_t::*close_browser() or indirectly
/// if the browser is parented to a top-level window created by CEF and the /// if the browser is parented to a top-level window created by CEF and the
/// user attempts to close that window (by clicking the 'X', for example). The /// user attempts to close that window (by clicking the 'X', for example). The

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=401b881a3bd1d0c36f9646804260f129eb5f70d9$ // $hash=62e7e781f3fef0d332b6a921d48a192fd0115295$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_MEDIA_ROUTER_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_MEDIA_ROUTER_CAPI_H_
@ -156,7 +156,7 @@ typedef struct _cef_media_observer_t {
cef_media_route_connection_state_t state); cef_media_route_connection_state_t state);
/// ///
/// A message was recieved over |route|. |message| is only valid for the scope /// A message was received over |route|. |message| is only valid for the scope
/// of this callback and should be copied if necessary. /// of this callback and should be copied if necessary.
/// ///
void(CEF_CALLBACK* on_route_message_received)( void(CEF_CALLBACK* on_route_message_received)(

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=2dcd17d131deb011094b741024aa11249e3fa306$ // $hash=5dae0b1a1271e79a5fd9b2c6e71e7a719a450161$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_MENU_MODEL_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_MENU_MODEL_CAPI_H_
@ -473,14 +473,15 @@ typedef struct _cef_menu_model_t {
/// ///
/// Sets the font list for the specified |command_id|. If |font_list| is NULL /// Sets the font list for the specified |command_id|. If |font_list| is NULL
/// the system font will be used. Returns true (1) on success. The format is /// the system font will be used. Returns true (1) on success. The format is
/// "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", where: - FONT_FAMILY_LIST is a /// "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", where:
/// comma-separated list of font family names, - STYLES is an optional space- /// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// separated list of style names /// - STYLES is an optional space-separated list of style names (case-
/// (case-sensitive "Bold" and "Italic" are supported), and /// sensitive "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: - "Arial, Helvetica, /// Here are examples of valid font description strings:
/// Bold Italic 14px" - "Arial, 14px" /// - "Arial, Helvetica, Bold Italic 14px"
/// - "Arial, 14px"
/// ///
int(CEF_CALLBACK* set_font_list)(struct _cef_menu_model_t* self, int(CEF_CALLBACK* set_font_list)(struct _cef_menu_model_t* self,
int command_id, int command_id,
@ -488,16 +489,15 @@ typedef struct _cef_menu_model_t {
/// ///
/// Sets the font list for the specified |index|. Specify an |index| value of /// Sets the font list for the specified |index|. Specify an |index| value of
/// -1 to set the default font. If |font_list| is NULL the system font will be /// - 1 to set the default font. If |font_list| is NULL the system font will
/// used. Returns true (1) on success. The format is /// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", where: - FONT_FAMILY_LIST is a /// - STYLES is an optional space-separated list of style names (case-
/// comma-separated list of font family names, - STYLES is an optional space- /// sensitive "Bold" and "Italic" are supported), and
/// separated list of style names
/// (case-sensitive "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: - "Arial, Helvetica, /// Here are examples of valid font description strings:
/// Bold Italic 14px" - "Arial, 14px" /// - "Arial, Helvetica, Bold Italic 14px"
/// - "Arial, 14px"
/// ///
int(CEF_CALLBACK* set_font_list_at)(struct _cef_menu_model_t* self, int(CEF_CALLBACK* set_font_list_at)(struct _cef_menu_model_t* self,
int index, int index,

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=ddad43a2c40d34b50baab5c4542e17faec189ba6$ // $hash=a61a639c7e53ecd9481eae363bac557055f0442e$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_PROCESS_UTIL_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_PROCESS_UTIL_CAPI_H_
@ -50,11 +50,11 @@ extern "C" {
/// Launches the process specified via |command_line|. Returns true (1) upon /// Launches the process specified via |command_line|. Returns true (1) upon
/// success. Must be called on the browser process TID_PROCESS_LAUNCHER thread. /// success. Must be called on the browser process TID_PROCESS_LAUNCHER thread.
/// ///
/// Unix-specific notes: - All file descriptors open in the parent process will /// Unix-specific notes:
/// be closed in the /// - All file descriptors open in the parent process will be closed in the
/// child process except for stdin, stdout, and stderr. /// child process except for stdin, stdout, and stderr.
/// - If the first argument on the command line does not contain a slash, /// - If the first argument on the command line does not contain a slash, PATH
/// PATH will be searched. (See man execvp.) /// will be searched. (See man execvp.)
/// ///
CEF_EXPORT int cef_launch_process(struct _cef_command_line_t* command_line); CEF_EXPORT int cef_launch_process(struct _cef_command_line_t* command_line);

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=199e86ccf09d571a5dd24f39b23ff5cc2bd32129$ // $hash=740d6eb5bea1bfc7c4ea413fefd3bf6586a81f20$
// //
#ifndef CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_CEF_TRACE_CAPI_H_
@ -80,8 +80,10 @@ typedef struct _cef_end_tracing_callback_t {
/// have an optional '-' prefix to make it an excluded category. Having both /// have an optional '-' prefix to make it an excluded category. Having both
/// included and excluded categories in the same list is not supported. /// included and excluded categories in the same list is not supported.
/// ///
/// Examples: - "test_MyTest*" - "test_MyTest*,test_OtherStuff" - /// Examples:
/// "-excluded_category1,-excluded_category2" /// - "test_MyTest*"
/// - "test_MyTest*,test_OtherStuff"
/// - "-excluded_category1,-excluded_category2"
/// ///
/// This function must be called on the browser process UI thread. /// This function must be called on the browser process UI thread.
/// ///

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=1c029e99b4b81f39fba362e297e85ec9bfcf16fb$ // $hash=06d17ed2939b57c97d73a0025e9f9ff65834b51a$
// //
#ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_LABEL_BUTTON_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_LABEL_BUTTON_CAPI_H_
@ -113,14 +113,15 @@ typedef struct _cef_label_button_t {
/// ///
/// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", /// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>",
/// where: - FONT_FAMILY_LIST is a comma-separated list of font family names, /// where:
/// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// - STYLES is an optional space-separated list of style names (case- /// - STYLES is an optional space-separated list of style names (case-
/// sensitive /// sensitive "Bold" and "Italic" are supported), and
/// "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: - "Arial, Helvetica, /// Here are examples of valid font description strings:
/// Bold Italic 14px" - "Arial, 14px" /// - "Arial, Helvetica, Bold Italic 14px"
/// - "Arial, 14px"
/// ///
void(CEF_CALLBACK* set_font_list)(struct _cef_label_button_t* self, void(CEF_CALLBACK* set_font_list)(struct _cef_label_button_t* self,
const cef_string_t* font_list); const cef_string_t* font_list);

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=f8474005e8b9e20dfb390e4b6fe0cc023dcebe3c$ // $hash=f47d33d79e9f321536aa87921d973745f6ec8b5e$
// //
#ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_TEXTFIELD_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_TEXTFIELD_CAPI_H_
@ -183,14 +183,15 @@ typedef struct _cef_textfield_t {
/// ///
/// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>", /// Sets the font list. The format is "<FONT_FAMILY_LIST>,[STYLES] <SIZE>",
/// where: - FONT_FAMILY_LIST is a comma-separated list of font family names, /// where:
/// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// - STYLES is an optional space-separated list of style names (case- /// - STYLES is an optional space-separated list of style names (case-
/// sensitive /// sensitive "Bold" and "Italic" are supported), and
/// "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: - "Arial, Helvetica, /// Here are examples of valid font description strings:
/// Bold Italic 14px" - "Arial, 14px" /// - "Arial, Helvetica, Bold Italic 14px"
/// - "Arial, 14px"
/// ///
void(CEF_CALLBACK* set_font_list)(struct _cef_textfield_t* self, void(CEF_CALLBACK* set_font_list)(struct _cef_textfield_t* self,
const cef_string_t* font_list); const cef_string_t* font_list);

View File

@ -33,7 +33,7 @@
// by hand. See the translator.README.txt file in the tools directory for // by hand. See the translator.README.txt file in the tools directory for
// more information. // more information.
// //
// $hash=afe2cd6a8c8af576d67cf099858c9920ded4a3c5$ // $hash=c894c96b089861c183059c54876af9ed9382e349$
// //
#ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_TEXTFIELD_DELEGATE_CAPI_H_ #ifndef CEF_INCLUDE_CAPI_VIEWS_CEF_TEXTFIELD_DELEGATE_CAPI_H_
@ -60,7 +60,7 @@ typedef struct _cef_textfield_delegate_t {
cef_view_delegate_t base; cef_view_delegate_t base;
/// ///
/// Called when |textfield| recieves a keyboard event. |event| contains /// Called when |textfield| receives a keyboard event. |event| contains
/// information about the keyboard event. Return true (1) if the keyboard /// information about the keyboard event. Return true (1) if the keyboard
/// event was handled or false (0) otherwise for default handling. /// event was handled or false (0) otherwise for default handling.
/// ///

View File

@ -115,8 +115,7 @@ class CefLabelButton : public CefButton {
/// where: /// where:
/// - FONT_FAMILY_LIST is a comma-separated list of font family names, /// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// - STYLES is an optional space-separated list of style names /// - STYLES is an optional space-separated list of style names
/// (case-sensitive /// (case-sensitive "Bold" and "Italic" are supported), and
/// "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: /// Here are examples of valid font description strings:

View File

@ -190,8 +190,7 @@ class CefTextfield : public CefView {
/// where: /// where:
/// - FONT_FAMILY_LIST is a comma-separated list of font family names, /// - FONT_FAMILY_LIST is a comma-separated list of font family names,
/// - STYLES is an optional space-separated list of style names /// - STYLES is an optional space-separated list of style names
/// (case-sensitive /// (case-sensitive "Bold" and "Italic" are supported), and
/// "Bold" and "Italic" are supported), and
/// - SIZE is an integer font size in pixels with the suffix "px". /// - SIZE is an integer font size in pixels with the suffix "px".
/// ///
/// Here are examples of valid font description strings: /// Here are examples of valid font description strings: