Commit ac4ab44a authored by Karandeep Bhatia's avatar Karandeep Bhatia Committed by Commit Bot

DNR: Prevent types from inlining to reduce nesting in documentation.

Types which are only referenced once are inlined by the Docserver by
default. This causes excessive nesting in documentation for
declarativeNetRequest. Prevent this by explicitly disallowing inlining
for these types.

BUG=1085326

Change-Id: I2d2a938832fdfd26915b8956b14f1d41e3b0a646
Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/2209966
Commit-Queue: Karan Bhatia <karandeepb@chromium.org>
Auto-Submit: Karan Bhatia <karandeepb@chromium.org>
Reviewed-by: default avatarDevlin <rdevlin.cronin@chromium.org>
Cr-Commit-Position: refs/heads/master@{#770954}
parent 860a9235
...@@ -88,6 +88,7 @@ namespace declarativeNetRequest { ...@@ -88,6 +88,7 @@ namespace declarativeNetRequest {
}; };
// Describes modification to various url components. // Describes modification to various url components.
[noinline_doc]
dictionary URLTransform { dictionary URLTransform {
// The new scheme for the request. Allowed values are "http", "https", // The new scheme for the request. Allowed values are "http", "https",
// "ftp" and "chrome-extension". // "ftp" and "chrome-extension".
...@@ -136,6 +137,7 @@ namespace declarativeNetRequest { ...@@ -136,6 +137,7 @@ namespace declarativeNetRequest {
DOMString? regexSubstitution; DOMString? regexSubstitution;
}; };
[noinline_doc]
dictionary RuleCondition { dictionary RuleCondition {
// The pattern which is matched against the network request url. // The pattern which is matched against the network request url.
...@@ -234,6 +236,7 @@ namespace declarativeNetRequest { ...@@ -234,6 +236,7 @@ namespace declarativeNetRequest {
HeaderOperation operation; HeaderOperation operation;
}; };
[noinline_doc]
dictionary RuleAction { dictionary RuleAction {
// The type of action to perform. // The type of action to perform.
RuleActionType type; RuleActionType type;
...@@ -283,6 +286,7 @@ namespace declarativeNetRequest { ...@@ -283,6 +286,7 @@ namespace declarativeNetRequest {
DOMString rulesetId; DOMString rulesetId;
}; };
[noinline_doc]
dictionary MatchedRuleInfo { dictionary MatchedRuleInfo {
MatchedRule rule; MatchedRule rule;
...@@ -309,6 +313,7 @@ namespace declarativeNetRequest { ...@@ -309,6 +313,7 @@ namespace declarativeNetRequest {
MatchedRuleInfo[] rulesMatchedInfo; MatchedRuleInfo[] rulesMatchedInfo;
}; };
[noinline_doc]
dictionary RequestDetails { dictionary RequestDetails {
// The ID of the request. Request IDs are unique within a browser session. // The ID of the request. Request IDs are unique within a browser session.
DOMString requestId; DOMString requestId;
...@@ -470,8 +475,8 @@ namespace declarativeNetRequest { ...@@ -470,8 +475,8 @@ namespace declarativeNetRequest {
// Fired when a rule is matched with a request. Only available for unpacked // Fired when a rule is matched with a request. Only available for unpacked
// extensions with the <code>declarativeNetRequestFeedback</code> permission // extensions with the <code>declarativeNetRequestFeedback</code> permission
// as this is intended to be used for debugging purposes only. // as this is intended to be used for debugging purposes only.
// |matched_rule_info|: The rule that has been matched along with // |info|: The rule that has been matched along with information about the
// information about the associated request. // associated request.
static void onRuleMatchedDebug(MatchedRuleInfoDebug matched_rule_info); static void onRuleMatchedDebug(MatchedRuleInfoDebug info);
}; };
}; };
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment