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:
@ -42,30 +42,30 @@
|
||||
#include "include/internal/cef_thread_internal.h"
|
||||
|
||||
///
|
||||
// A simple thread abstraction that establishes a message loop on a new thread.
|
||||
// The consumer uses CefTaskRunner to execute code on the thread's message loop.
|
||||
// The thread is terminated when the CefThread object is destroyed or Stop() is
|
||||
// called. All pending tasks queued on the thread's message loop will run to
|
||||
// completion before the thread is terminated. CreateThread() can be called on
|
||||
// any valid CEF thread in either the browser or render process. This class
|
||||
// should only be used for tasks that require a dedicated thread. In most cases
|
||||
// you can post tasks to an existing CEF thread instead of creating a new one;
|
||||
// see cef_task.h for details.
|
||||
/// A simple thread abstraction that establishes a message loop on a new thread.
|
||||
/// The consumer uses CefTaskRunner to execute code on the thread's message
|
||||
/// loop. The thread is terminated when the CefThread object is destroyed or
|
||||
/// Stop() is called. All pending tasks queued on the thread's message loop will
|
||||
/// run to completion before the thread is terminated. CreateThread() can be
|
||||
/// called on any valid CEF thread in either the browser or render process. This
|
||||
/// class should only be used for tasks that require a dedicated thread. In most
|
||||
/// cases you can post tasks to an existing CEF thread instead of creating a new
|
||||
/// one; see cef_task.h for details.
|
||||
///
|
||||
/*--cef(source=library)--*/
|
||||
class CefThread : public CefBaseRefCounted {
|
||||
public:
|
||||
///
|
||||
// Create and start a new thread. This method does not block waiting for the
|
||||
// thread to run initialization. |display_name| is the name that will be used
|
||||
// to identify the thread. |priority| is the thread execution priority.
|
||||
// |message_loop_type| indicates the set of asynchronous events that the
|
||||
// thread can process. If |stoppable| is true the thread will stopped and
|
||||
// joined on destruction or when Stop() is called; otherwise, the thread
|
||||
// cannot be stopped and will be leaked on shutdown. On Windows the
|
||||
// |com_init_mode| value specifies how COM will be initialized for the thread.
|
||||
// If |com_init_mode| is set to COM_INIT_MODE_STA then |message_loop_type|
|
||||
// must be set to ML_TYPE_UI.
|
||||
/// Create and start a new thread. This method does not block waiting for the
|
||||
/// thread to run initialization. |display_name| is the name that will be used
|
||||
/// to identify the thread. |priority| is the thread execution priority.
|
||||
/// |message_loop_type| indicates the set of asynchronous events that the
|
||||
/// thread can process. If |stoppable| is true the thread will stopped and
|
||||
/// joined on destruction or when Stop() is called; otherwise, the thread
|
||||
/// cannot be stopped and will be leaked on shutdown. On Windows the
|
||||
/// |com_init_mode| value specifies how COM will be initialized for the
|
||||
/// thread. If |com_init_mode| is set to COM_INIT_MODE_STA then
|
||||
/// |message_loop_type| must be set to ML_TYPE_UI.
|
||||
///
|
||||
/*--cef(optional_param=display_name)--*/
|
||||
static CefRefPtr<CefThread> CreateThread(
|
||||
@ -76,8 +76,8 @@ class CefThread : public CefBaseRefCounted {
|
||||
cef_com_init_mode_t com_init_mode);
|
||||
|
||||
///
|
||||
// Create and start a new thread with default/recommended values.
|
||||
// |display_name| is the name that will be used to identify the thread.
|
||||
/// Create and start a new thread with default/recommended values.
|
||||
/// |display_name| is the name that will be used to identify the thread.
|
||||
///
|
||||
static CefRefPtr<CefThread> CreateThread(const CefString& display_name) {
|
||||
return CreateThread(display_name, TP_NORMAL, ML_TYPE_DEFAULT, true,
|
||||
@ -85,30 +85,30 @@ class CefThread : public CefBaseRefCounted {
|
||||
}
|
||||
|
||||
///
|
||||
// Returns the CefTaskRunner that will execute code on this thread's message
|
||||
// loop. This method is safe to call from any thread.
|
||||
/// Returns the CefTaskRunner that will execute code on this thread's message
|
||||
/// loop. This method is safe to call from any thread.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual CefRefPtr<CefTaskRunner> GetTaskRunner() = 0;
|
||||
|
||||
///
|
||||
// Returns the platform thread ID. It will return the same value after Stop()
|
||||
// is called. This method is safe to call from any thread.
|
||||
/// Returns the platform thread ID. It will return the same value after Stop()
|
||||
/// is called. This method is safe to call from any thread.
|
||||
///
|
||||
/*--cef(default_retval=kInvalidPlatformThreadId)--*/
|
||||
virtual cef_platform_thread_id_t GetPlatformThreadId() = 0;
|
||||
|
||||
///
|
||||
// Stop and join the thread. This method must be called from the same thread
|
||||
// that called CreateThread(). Do not call this method if CreateThread() was
|
||||
// called with a |stoppable| value of false.
|
||||
/// Stop and join the thread. This method must be called from the same thread
|
||||
/// that called CreateThread(). Do not call this method if CreateThread() was
|
||||
/// called with a |stoppable| value of false.
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual void Stop() = 0;
|
||||
|
||||
///
|
||||
// Returns true if the thread is currently running. This method must be called
|
||||
// from the same thread that called CreateThread().
|
||||
/// Returns true if the thread is currently running. This method must be
|
||||
/// called from the same thread that called CreateThread().
|
||||
///
|
||||
/*--cef()--*/
|
||||
virtual bool IsRunning() = 0;
|
||||
|
Reference in New Issue
Block a user