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
@ -33,7 +33,7 @@
|
||||
// by hand. See the translator.README.txt file in the tools directory for
|
||||
// more information.
|
||||
//
|
||||
// $hash=f5e1c0fc43c6e85dbafa66975d9dc5e2bc7be69f$
|
||||
// $hash=a6cb0abd77320cfd9ddfa3f16ca0a6ff3987521a$
|
||||
//
|
||||
|
||||
#ifndef CEF_INCLUDE_CAPI_CEF_PARSER_CAPI_H_
|
||||
@ -47,84 +47,84 @@ extern "C" {
|
||||
#endif
|
||||
|
||||
///
|
||||
// Parse the specified |url| into its component parts. Returns false (0) if the
|
||||
// URL is NULL or invalid.
|
||||
/// Parse the specified |url| into its component parts. Returns false (0) if the
|
||||
/// URL is NULL or invalid.
|
||||
///
|
||||
CEF_EXPORT int cef_parse_url(const cef_string_t* url,
|
||||
struct _cef_urlparts_t* parts);
|
||||
|
||||
///
|
||||
// Creates a URL from the specified |parts|, which must contain a non-NULL spec
|
||||
// or a non-NULL host and path (at a minimum), but not both. Returns false (0)
|
||||
// if |parts| isn't initialized as described.
|
||||
/// Creates a URL from the specified |parts|, which must contain a non-NULL spec
|
||||
/// or a non-NULL host and path (at a minimum), but not both. Returns false (0)
|
||||
/// if |parts| isn't initialized as described.
|
||||
///
|
||||
CEF_EXPORT int cef_create_url(const struct _cef_urlparts_t* parts,
|
||||
cef_string_t* url);
|
||||
|
||||
///
|
||||
// This is a convenience function for formatting a URL in a concise and human-
|
||||
// friendly way to help users make security-related decisions (or in other
|
||||
// circumstances when people need to distinguish sites, origins, or otherwise-
|
||||
// simplified URLs from each other). Internationalized domain names (IDN) may be
|
||||
// presented in Unicode if the conversion is considered safe. The returned value
|
||||
// will (a) omit the path for standard schemes, excepting file and filesystem,
|
||||
// and (b) omit the port if it is the default for the scheme. Do not use this
|
||||
// for URLs which will be parsed or sent to other applications.
|
||||
/// This is a convenience function for formatting a URL in a concise and human-
|
||||
/// friendly way to help users make security-related decisions (or in other
|
||||
/// circumstances when people need to distinguish sites, origins, or otherwise-
|
||||
/// simplified URLs from each other). Internationalized domain names (IDN) may
|
||||
/// be presented in Unicode if the conversion is considered safe. The returned
|
||||
/// value will (a) omit the path for standard schemes, excepting file and
|
||||
/// filesystem, and (b) omit the port if it is the default for the scheme. Do
|
||||
/// not use this for URLs which will be parsed or sent to other applications.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t
|
||||
cef_format_url_for_security_display(const cef_string_t* origin_url);
|
||||
|
||||
///
|
||||
// Returns the mime type for the specified file extension or an NULL string if
|
||||
// unknown.
|
||||
/// Returns the mime type for the specified file extension or an NULL string if
|
||||
/// unknown.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t
|
||||
cef_get_mime_type(const cef_string_t* extension);
|
||||
|
||||
///
|
||||
// Get the extensions associated with the given mime type. This should be passed
|
||||
// in lower case. There could be multiple extensions for a given mime type, like
|
||||
// "html,htm" for "text/html", or "txt,text,html,..." for "text/*". Any existing
|
||||
// elements in the provided vector will not be erased.
|
||||
/// Get the extensions associated with the given mime type. This should be
|
||||
/// passed in lower case. There could be multiple extensions for a given mime
|
||||
/// type, like "html,htm" for "text/html", or "txt,text,html,..." for "text/*".
|
||||
/// Any existing elements in the provided vector will not be erased.
|
||||
///
|
||||
CEF_EXPORT void cef_get_extensions_for_mime_type(const cef_string_t* mime_type,
|
||||
cef_string_list_t extensions);
|
||||
|
||||
///
|
||||
// Encodes |data| as a base64 string.
|
||||
/// Encodes |data| as a base64 string.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t cef_base64encode(const void* data,
|
||||
size_t data_size);
|
||||
|
||||
///
|
||||
// Decodes the base64 encoded string |data|. The returned value will be NULL if
|
||||
// the decoding fails.
|
||||
/// Decodes the base64 encoded string |data|. The returned value will be NULL if
|
||||
/// the decoding fails.
|
||||
///
|
||||
CEF_EXPORT struct _cef_binary_value_t* cef_base64decode(
|
||||
const cef_string_t* data);
|
||||
|
||||
///
|
||||
// Escapes characters in |text| which are unsuitable for use as a query
|
||||
// parameter value. Everything except alphanumerics and -_.!~*'() will be
|
||||
// converted to "%XX". If |use_plus| is true (1) spaces will change to "+". The
|
||||
// result is basically the same as encodeURIComponent in Javacript.
|
||||
/// Escapes characters in |text| which are unsuitable for use as a query
|
||||
/// parameter value. Everything except alphanumerics and -_.!~*'() will be
|
||||
/// converted to "%XX". If |use_plus| is true (1) spaces will change to "+". The
|
||||
/// result is basically the same as encodeURIComponent in Javacript.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t cef_uriencode(const cef_string_t* text,
|
||||
int use_plus);
|
||||
|
||||
///
|
||||
// Unescapes |text| and returns the result. Unescaping consists of looking for
|
||||
// the exact pattern "%XX" where each X is a hex digit and converting to the
|
||||
// character with the numerical value of those digits (e.g. "i%20=%203%3b"
|
||||
// unescapes to "i = 3;"). If |convert_to_utf8| is true (1) this function will
|
||||
// attempt to interpret the initial decoded result as UTF-8. If the result is
|
||||
// convertable into UTF-8 it will be returned as converted. Otherwise the
|
||||
// initial decoded result will be returned. The |unescape_rule| parameter
|
||||
// supports further customization the decoding process.
|
||||
/// Unescapes |text| and returns the result. Unescaping consists of looking for
|
||||
/// the exact pattern "%XX" where each X is a hex digit and converting to the
|
||||
/// character with the numerical value of those digits (e.g. "i%20=%203%3b"
|
||||
/// unescapes to "i = 3;"). If |convert_to_utf8| is true (1) this function will
|
||||
/// attempt to interpret the initial decoded result as UTF-8. If the result is
|
||||
/// convertable into UTF-8 it will be returned as converted. Otherwise the
|
||||
/// initial decoded result will be returned. The |unescape_rule| parameter
|
||||
/// supports further customization the decoding process.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t
|
||||
@ -133,17 +133,17 @@ cef_uridecode(const cef_string_t* text,
|
||||
cef_uri_unescape_rule_t unescape_rule);
|
||||
|
||||
///
|
||||
// Parses the specified |json_string| and returns a dictionary or list
|
||||
// representation. If JSON parsing fails this function returns NULL.
|
||||
/// Parses the specified |json_string| and returns a dictionary or list
|
||||
/// representation. If JSON parsing fails this function returns NULL.
|
||||
///
|
||||
CEF_EXPORT struct _cef_value_t* cef_parse_json(
|
||||
const cef_string_t* json_string,
|
||||
cef_json_parser_options_t options);
|
||||
|
||||
///
|
||||
// Parses the specified UTF8-encoded |json| buffer of size |json_size| and
|
||||
// returns a dictionary or list representation. If JSON parsing fails this
|
||||
// function returns NULL.
|
||||
/// Parses the specified UTF8-encoded |json| buffer of size |json_size| and
|
||||
/// returns a dictionary or list representation. If JSON parsing fails this
|
||||
/// function returns NULL.
|
||||
///
|
||||
CEF_EXPORT struct _cef_value_t* cef_parse_json_buffer(
|
||||
const void* json,
|
||||
@ -151,9 +151,9 @@ CEF_EXPORT struct _cef_value_t* cef_parse_json_buffer(
|
||||
cef_json_parser_options_t options);
|
||||
|
||||
///
|
||||
// Parses the specified |json_string| and returns a dictionary or list
|
||||
// representation. If JSON parsing fails this function returns NULL and
|
||||
// populates |error_msg_out| with a formatted error message.
|
||||
/// Parses the specified |json_string| and returns a dictionary or list
|
||||
/// representation. If JSON parsing fails this function returns NULL and
|
||||
/// populates |error_msg_out| with a formatted error message.
|
||||
///
|
||||
CEF_EXPORT struct _cef_value_t* cef_parse_jsonand_return_error(
|
||||
const cef_string_t* json_string,
|
||||
@ -161,9 +161,9 @@ CEF_EXPORT struct _cef_value_t* cef_parse_jsonand_return_error(
|
||||
cef_string_t* error_msg_out);
|
||||
|
||||
///
|
||||
// Generates a JSON string from the specified root |node| which should be a
|
||||
// dictionary or list value. Returns an NULL string on failure. This function
|
||||
// requires exclusive access to |node| including any underlying data.
|
||||
/// Generates a JSON string from the specified root |node| which should be a
|
||||
/// dictionary or list value. Returns an NULL string on failure. This function
|
||||
/// requires exclusive access to |node| including any underlying data.
|
||||
///
|
||||
// The resulting string must be freed by calling cef_string_userfree_free().
|
||||
CEF_EXPORT cef_string_userfree_t
|
||||
|
||||
Reference in New Issue
Block a user