Fix documentation errors (issue #934).

git-svn-id: https://chromiumembedded.googlecode.com/svn/trunk@1179 5089003a-bbd8-11dd-ad1f-f1f9622dbc98
This commit is contained in:
Marshall Greenblatt
2013-04-05 17:19:26 +00:00
parent 0343aa5236
commit ba2fa28c05
6 changed files with 20 additions and 14 deletions

View File

@ -131,7 +131,9 @@ typedef struct _cef_frame_t {
const cef_string_t* url); const cef_string_t* url);
/// ///
// Load the contents of |string_val| with the optional dummy target |url|. // Load the contents of |string_val| with the specified dummy |url|. |url|
// should have a standard scheme (for example, http scheme) or behaviors like
// link clicks and web security restrictions may not behave as expected.
/// ///
void (CEF_CALLBACK *load_string)(struct _cef_frame_t* self, void (CEF_CALLBACK *load_string)(struct _cef_frame_t* self,
const cef_string_t* string_val, const cef_string_t* url); const cef_string_t* string_val, const cef_string_t* url);

View File

@ -140,11 +140,12 @@ typedef struct _cef_scheme_handler_factory_t {
cef_base_t base; cef_base_t base;
/// ///
// Return a new resource handler instance to handle the request. |browser| and // Return a new resource handler instance to handle the request or an NULL
// |frame| will be the browser window and frame respectively that originated // reference to allow default handling of the request. |browser| and |frame|
// the request or NULL if the request did not originate from a browser window // will be the browser window and frame respectively that originated the
// (for example, if the request came from cef_urlrequest_t). The |request| // request or NULL if the request did not originate from a browser window (for
// object passed to this function will not contain cookie data. // example, if the request came from cef_urlrequest_t). The |request| object
// passed to this function will not contain cookie data.
/// ///
struct _cef_resource_handler_t* (CEF_CALLBACK *create)( struct _cef_resource_handler_t* (CEF_CALLBACK *create)(
struct _cef_scheme_handler_factory_t* self, struct _cef_scheme_handler_factory_t* self,

View File

@ -69,7 +69,7 @@ CEF_EXPORT int cef_begin_tracing(struct _cef_trace_client_t* client,
// Get the maximum trace buffer percent full state across all processes. // Get the maximum trace buffer percent full state across all processes.
// //
// cef_trace_client_t::OnTraceBufferPercentFullReply will be called // cef_trace_client_t::OnTraceBufferPercentFullReply will be called
// asynchronously after the value is determibed. When any child process reaches // asynchronously after the value is determined. When any child process reaches
// 100% full tracing will end automatically and // 100% full tracing will end automatically and
// cef_trace_client_t::OnEndTracingComplete will be called. This function fails // cef_trace_client_t::OnEndTracingComplete will be called. This function fails
// and returns false (0) if trace is ending or disabled, no cef_trace_client_t // and returns false (0) if trace is ending or disabled, no cef_trace_client_t

View File

@ -139,7 +139,9 @@ class CefFrame : public virtual CefBase {
virtual void LoadURL(const CefString& url) =0; virtual void LoadURL(const CefString& url) =0;
/// ///
// Load the contents of |string_val| with the optional dummy target |url|. // Load the contents of |string_val| with the specified dummy |url|. |url|
// should have a standard scheme (for example, http scheme) or behaviors like
// link clicks and web security restrictions may not behave as expected.
/// ///
/*--cef()--*/ /*--cef()--*/
virtual void LoadString(const CefString& string_val, virtual void LoadString(const CefString& string_val,

View File

@ -142,11 +142,12 @@ class CefSchemeRegistrar : public virtual CefBase {
class CefSchemeHandlerFactory : public virtual CefBase { class CefSchemeHandlerFactory : public virtual CefBase {
public: public:
/// ///
// Return a new resource handler instance to handle the request. |browser| // Return a new resource handler instance to handle the request or an empty
// and |frame| will be the browser window and frame respectively that // reference to allow default handling of the request. |browser| and |frame|
// originated the request or NULL if the request did not originate from a // will be the browser window and frame respectively that originated the
// browser window (for example, if the request came from CefURLRequest). The // request or NULL if the request did not originate from a browser window
// |request| object passed to this method will not contain cookie data. // (for example, if the request came from CefURLRequest). The |request| object
// passed to this method will not contain cookie data.
/// ///
/*--cef(optional_param=browser,optional_param=frame)--*/ /*--cef(optional_param=browser,optional_param=frame)--*/
virtual CefRefPtr<CefResourceHandler> Create( virtual CefRefPtr<CefResourceHandler> Create(

View File

@ -99,7 +99,7 @@ bool CefBeginTracing(CefRefPtr<CefTraceClient> client,
// Get the maximum trace buffer percent full state across all processes. // Get the maximum trace buffer percent full state across all processes.
// //
// CefTraceClient::OnTraceBufferPercentFullReply will be called asynchronously // CefTraceClient::OnTraceBufferPercentFullReply will be called asynchronously
// after the value is determibed. When any child process reaches 100% full // after the value is determined. When any child process reaches 100% full
// tracing will end automatically and CefTraceClient::OnEndTracingComplete // tracing will end automatically and CefTraceClient::OnEndTracingComplete
// will be called. This function fails and returns false if trace is ending or // will be called. This function fails and returns false if trace is ending or
// disabled, no CefTraceClient was passed to CefBeginTracing, or if a previous // disabled, no CefTraceClient was passed to CefBeginTracing, or if a previous