mirror of
https://bitbucket.org/chromiumembedded/cef
synced 2025-06-05 21:39:12 +02:00
Update include/ comments to Doxygen formatting (see issue #3384)
See related guidelines in the issue.
This commit is contained in:
Marshall Greenblatt
@ -48,16 +48,16 @@
|
||||
class CefApp;
|
||||
|
||||
///
|
||||
// This function should be called from the application entry point function to
|
||||
// execute a secondary process. It can be used to run secondary processes from
|
||||
// the browser client executable (default behavior) or from a separate
|
||||
// executable specified by the CefSettings.browser_subprocess_path value. If
|
||||
// called for the browser process (identified by no "type" command-line value)
|
||||
// it will return immediately with a value of -1. If called for a recognized
|
||||
// secondary process it will block until the process should exit and then return
|
||||
// the process exit code. The |application| parameter may be empty. The
|
||||
// |windows_sandbox_info| parameter is only used on Windows and may be NULL (see
|
||||
// cef_sandbox_win.h for details).
|
||||
/// This function should be called from the application entry point function to
|
||||
/// execute a secondary process. It can be used to run secondary processes from
|
||||
/// the browser client executable (default behavior) or from a separate
|
||||
/// executable specified by the cef_settings_t.browser_subprocess_path value. If
|
||||
/// called for the browser process (identified by no "type" command-line value)
|
||||
/// it will return immediately with a value of -1. If called for a recognized
|
||||
/// secondary process it will block until the process should exit and then
|
||||
/// return the process exit code. The |application| parameter may be empty. The
|
||||
/// |windows_sandbox_info| parameter is only used on Windows and may be NULL
|
||||
/// (see cef_sandbox_win.h for details).
|
||||
///
|
||||
/*--cef(api_hash_check,optional_param=application,
|
||||
optional_param=windows_sandbox_info)--*/
|
||||
@ -66,11 +66,11 @@ int CefExecuteProcess(const CefMainArgs& args,
|
||||
void* windows_sandbox_info);
|
||||
|
||||
///
|
||||
// This function should be called on the main application thread to initialize
|
||||
// the CEF browser process. The |application| parameter may be empty. A return
|
||||
// value of true indicates that it succeeded and false indicates that it failed.
|
||||
// The |windows_sandbox_info| parameter is only used on Windows and may be NULL
|
||||
// (see cef_sandbox_win.h for details).
|
||||
/// This function should be called on the main application thread to initialize
|
||||
/// the CEF browser process. The |application| parameter may be empty. A return
|
||||
/// value of true indicates that it succeeded and false indicates that it
|
||||
/// failed. The |windows_sandbox_info| parameter is only used on Windows and may
|
||||
/// be NULL (see cef_sandbox_win.h for details).
|
||||
///
|
||||
/*--cef(api_hash_check,optional_param=application,
|
||||
optional_param=windows_sandbox_info)--*/
|
||||
@ -80,80 +80,82 @@ bool CefInitialize(const CefMainArgs& args,
|
||||
void* windows_sandbox_info);
|
||||
|
||||
///
|
||||
// This function should be called on the main application thread to shut down
|
||||
// the CEF browser process before the application exits.
|
||||
/// This function should be called on the main application thread to shut down
|
||||
/// the CEF browser process before the application exits.
|
||||
///
|
||||
/*--cef()--*/
|
||||
void CefShutdown();
|
||||
|
||||
///
|
||||
// Perform a single iteration of CEF message loop processing. This function is
|
||||
// provided for cases where the CEF message loop must be integrated into an
|
||||
// existing application message loop. Use of this function is not recommended
|
||||
// for most users; use either the CefRunMessageLoop() function or
|
||||
// CefSettings.multi_threaded_message_loop if possible. When using this function
|
||||
// care must be taken to balance performance against excessive CPU usage. It is
|
||||
// recommended to enable the CefSettings.external_message_pump option when using
|
||||
// this function so that CefBrowserProcessHandler::OnScheduleMessagePumpWork()
|
||||
// callbacks can facilitate the scheduling process. This function should only be
|
||||
// called on the main application thread and only if CefInitialize() is called
|
||||
// with a CefSettings.multi_threaded_message_loop value of false. This function
|
||||
// will not block.
|
||||
/// Perform a single iteration of CEF message loop processing. This function is
|
||||
/// provided for cases where the CEF message loop must be integrated into an
|
||||
/// existing application message loop. Use of this function is not recommended
|
||||
/// for most users; use either the CefRunMessageLoop() function or
|
||||
/// cef_settings_t.multi_threaded_message_loop if possible. When using this
|
||||
/// function care must be taken to balance performance against excessive CPU
|
||||
/// usage. It is recommended to enable the cef_settings_t.external_message_pump
|
||||
/// option when using this function so that
|
||||
/// CefBrowserProcessHandler::OnScheduleMessagePumpWork() callbacks can
|
||||
/// facilitate the scheduling process. This function should only be called on
|
||||
/// the main application thread and only if CefInitialize() is called with a
|
||||
/// cef_settings_t.multi_threaded_message_loop value of false. This function
|
||||
/// will not block.
|
||||
///
|
||||
/*--cef()--*/
|
||||
void CefDoMessageLoopWork();
|
||||
|
||||
///
|
||||
// Run the CEF message loop. Use this function instead of an application-
|
||||
// provided message loop to get the best balance between performance and CPU
|
||||
// usage. This function should only be called on the main application thread and
|
||||
// only if CefInitialize() is called with a
|
||||
// CefSettings.multi_threaded_message_loop value of false. This function will
|
||||
// block until a quit message is received by the system.
|
||||
/// Run the CEF message loop. Use this function instead of an application-
|
||||
/// provided message loop to get the best balance between performance and CPU
|
||||
/// usage. This function should only be called on the main application thread
|
||||
/// and only if CefInitialize() is called with a
|
||||
/// cef_settings_t.multi_threaded_message_loop value of false. This function
|
||||
/// will block until a quit message is received by the system.
|
||||
///
|
||||
/*--cef()--*/
|
||||
void CefRunMessageLoop();
|
||||
|
||||
///
|
||||
// Quit the CEF message loop that was started by calling CefRunMessageLoop().
|
||||
// This function should only be called on the main application thread and only
|
||||
// if CefRunMessageLoop() was used.
|
||||
/// Quit the CEF message loop that was started by calling CefRunMessageLoop().
|
||||
/// This function should only be called on the main application thread and only
|
||||
/// if CefRunMessageLoop() was used.
|
||||
///
|
||||
/*--cef()--*/
|
||||
void CefQuitMessageLoop();
|
||||
|
||||
///
|
||||
// Set to true before calling Windows APIs like TrackPopupMenu that enter a
|
||||
// modal message loop. Set to false after exiting the modal message loop.
|
||||
/// Set to true before calling Windows APIs like TrackPopupMenu that enter a
|
||||
/// modal message loop. Set to false after exiting the modal message loop.
|
||||
///
|
||||
/*--cef()--*/
|
||||
void CefSetOSModalLoop(bool osModalLoop);
|
||||
|
||||
///
|
||||
// Call during process startup to enable High-DPI support on Windows 7 or newer.
|
||||
// Older versions of Windows should be left DPI-unaware because they do not
|
||||
// support DirectWrite and GDI fonts are kerned very badly.
|
||||
/// Call during process startup to enable High-DPI support on Windows 7 or
|
||||
/// newer. Older versions of Windows should be left DPI-unaware because they do
|
||||
/// not support DirectWrite and GDI fonts are kerned very badly.
|
||||
///
|
||||
/*--cef(capi_name=cef_enable_highdpi_support)--*/
|
||||
void CefEnableHighDPISupport();
|
||||
|
||||
///
|
||||
// Implement this interface to provide handler implementations. Methods will be
|
||||
// called by the process and/or thread indicated.
|
||||
/// Implement this interface to provide handler implementations. Methods will be
|
||||
/// called by the process and/or thread indicated.
|
||||
///
|
||||
/*--cef(source=client,no_debugct_check)--*/
|
||||
class CefApp : public virtual CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Provides an opportunity to view and/or modify command-line arguments before
|
||||
// processing by CEF and Chromium. The |process_type| value will be empty for
|
||||
// the browser process. Do not keep a reference to the CefCommandLine object
|
||||
// passed to this method. The CefSettings.command_line_args_disabled value
|
||||
// can be used to start with an empty command-line object. Any values
|
||||
// specified in CefSettings that equate to command-line arguments will be set
|
||||
// before this method is called. Be cautious when using this method to modify
|
||||
// command-line arguments for non-browser processes as this may result in
|
||||
// undefined behavior including crashes.
|
||||
/// Provides an opportunity to view and/or modify command-line arguments
|
||||
/// before processing by CEF and Chromium. The |process_type| value will be
|
||||
/// empty for the browser process. Do not keep a reference to the
|
||||
/// CefCommandLine object passed to this method. The
|
||||
/// cef_settings_t.command_line_args_disabled value can be used to start with
|
||||
/// an empty command-line object. Any values specified in CefSettings that
|
||||
/// equate to command-line arguments will be set before this method is called.
|
||||
/// Be cautious when using this method to modify command-line arguments for
|
||||
/// non-browser processes as this may result in undefined behavior including
|
||||
/// crashes.
|
||||
///
|
||||
/*--cef(optional_param=process_type)--*/
|
||||
virtual void OnBeforeCommandLineProcessing(
|
||||
@ -161,20 +163,20 @@ class CefApp : public virtual CefBaseRefCounted {
|
||||
CefRefPtr<CefCommandLine> command_line) {}
|
||||
|
||||
///
|
||||
// Provides an opportunity to register custom schemes. Do not keep a reference
|
||||
// to the |registrar| object. This method is called on the main thread for
|
||||
// each process and the registered schemes should be the same across all
|
||||
// processes.
|
||||
/// Provides an opportunity to register custom schemes. Do not keep a
|
||||
/// reference to the |registrar| object. This method is called on the main
|
||||
/// thread for each process and the registered schemes should be the same
|
||||
/// across all processes.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void OnRegisterCustomSchemes(
|
||||
CefRawPtr<CefSchemeRegistrar> registrar) {}
|
||||
|
||||
///
|
||||
// Return the handler for resource bundle events. If
|
||||
// CefSettings.pack_loading_disabled is true a handler must be returned. If no
|
||||
// handler is returned resources will be loaded from pack files. This method
|
||||
// is called by the browser and render processes on multiple threads.
|
||||
/// Return the handler for resource bundle events. If
|
||||
/// cef_settings_t.pack_loading_disabled is true a handler must be returned.
|
||||
/// If no handler is returned resources will be loaded from pack files. This
|
||||
/// method is called by the browser and render processes on multiple threads.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefResourceBundleHandler> GetResourceBundleHandler() {
|
||||
@ -182,8 +184,8 @@ class CefApp : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Return the handler for functionality specific to the browser process. This
|
||||
// method is called on multiple threads in the browser process.
|
||||
/// Return the handler for functionality specific to the browser process. This
|
||||
/// method is called on multiple threads in the browser process.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefBrowserProcessHandler> GetBrowserProcessHandler() {
|
||||
@ -191,8 +193,8 @@ class CefApp : public virtual CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Return the handler for functionality specific to the render process. This
|
||||
// method is called on the render process main thread.
|
||||
/// Return the handler for functionality specific to the render process. This
|
||||
/// method is called on the render process main thread.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefRenderProcessHandler> GetRenderProcessHandler() {
|
||||
|
||||
Reference in New Issue
Block a user