From 174c15212ae0a6bf89982db61ef5ac5b7850c0f7 Mon Sep 17 00:00:00 2001 From: Sam Rawlins Date: Wed, 15 Oct 2025 13:43:58 -0700 Subject: [PATCH] DAS: Comply with unintended_html_in_doc_comment Change-Id: Ic96bb851e4f18d11badb3e429f5601e652f89b1a Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/454162 Reviewed-by: Brian Wilkerson Commit-Queue: Samuel Rawlins --- pkg/analysis_server/analysis_options.yaml | 2 - .../support/integration_test_methods.dart | 442 +++++++++--------- .../lib/src/server/driver.dart | 2 +- .../lib/src/server/sdk_configuration.dart | 2 +- .../fix/data_driven/code_fragment_parser.dart | 28 +- .../src/services/kythe/kythe_visitors.dart | 2 +- .../src/utilities/stream_string_stink.dart | 2 +- .../support/integration_test_methods.dart | 134 +++--- .../lib/text_formatter.dart | 5 +- 9 files changed, 310 insertions(+), 309 deletions(-) diff --git a/pkg/analysis_server/analysis_options.yaml b/pkg/analysis_server/analysis_options.yaml index 43f95ec9747..41a50c2874c 100644 --- a/pkg/analysis_server/analysis_options.yaml +++ b/pkg/analysis_server/analysis_options.yaml @@ -21,8 +21,6 @@ analyzer: implementation_imports: ignore overridden_fields: ignore todo: ignore - # Existing violations (361) - unintended_html_in_doc_comment: ignore linter: rules: diff --git a/pkg/analysis_server/integration_test/support/integration_test_methods.dart b/pkg/analysis_server/integration_test/support/integration_test_methods.dart index e941bf98c32..d259ce807c9 100644 --- a/pkg/analysis_server/integration_test/support/integration_test_methods.dart +++ b/pkg/analysis_server/integration_test/support/integration_test_methods.dart @@ -32,7 +32,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// version: String + /// * `version: String` /// /// The version number of the analysis server. Future sendServerGetVersion() async { @@ -65,7 +65,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// subscriptions: List + /// * `subscriptions: List` /// /// A list of the services being subscribed to. Future sendServerSetSubscriptions( @@ -88,7 +88,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// id: String + /// * `id: String` /// /// The id of the request that should be cancelled. Future sendServerCancelRequest(String id) async { @@ -104,7 +104,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// requests: List + /// * `requests: List` /// /// The names of the requests that the server can safely send to the /// client. Only requests whose name is in the list will be sent. @@ -120,7 +120,7 @@ abstract class IntegrationTest { /// - `openUrlRequest` /// - `showMessageRequest` /// - /// supportsUris: bool (optional) + /// * `supportsUris: bool (optional)` /// /// True if the client supports the server sending URIs in place of file /// paths. @@ -134,7 +134,7 @@ abstract class IntegrationTest { /// LSP notifications are automatically enabled when the client sets this /// capability. /// - /// lspCapabilities: object (optional) + /// * `lspCapabilities: object (optional)` /// /// LSP capabilities of the client as defined by the Language Server /// Protocol specification. @@ -172,7 +172,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// url: String + /// * `url: String` /// /// The URL to be opened. Future sendServerOpenUrlRequest(String url) async { @@ -200,21 +200,21 @@ abstract class IntegrationTest { /// /// Parameters /// - /// type: MessageType + /// * `type: MessageType` /// /// The type of the message. /// - /// message: String + /// * `message: String` /// /// The message to be displayed. /// - /// actions: List + /// * `actions: List` /// /// The labels of the buttons by which the user can dismiss the message. /// /// Returns /// - /// action: String (optional) + /// * `action: String (optional)` /// /// The label of the action that was selected by the user. May be omitted /// or `null` if the user dismissed the message without clicking an action @@ -247,11 +247,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// version: String + /// * `version: String` /// /// The version number of the analysis server. /// - /// pid: int + /// * `pid: int` /// /// The process id of the analysis server process. late final Stream onServerConnected = @@ -272,16 +272,16 @@ abstract class IntegrationTest { /// /// Parameters /// - /// isFatal: bool + /// * `isFatal: bool` /// /// True if the error is a fatal error, meaning that the server will /// shutdown automatically after sending this notification. /// - /// message: String + /// * `message: String` /// /// The error message indicating what kind of error was encountered. /// - /// stackTrace: String + /// * `stackTrace: String` /// /// The stack trace associated with the generation of the error, used for /// debugging the server. @@ -298,7 +298,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// message: String + /// * `message: String` /// /// The error message indicating what kind of error was encountered. late final Stream onServerPluginError = @@ -313,7 +313,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// entry: ServerLogEntry + /// * `entry: ServerLogEntry` late final Stream onServerLog = _onServerLog.stream .asBroadcastStream(); @@ -329,12 +329,12 @@ abstract class IntegrationTest { /// /// Parameters /// - /// analysis: AnalysisStatus (optional) + /// * `analysis: AnalysisStatus (optional)` /// /// The current status of analysis, including whether analysis is being /// performed and if so what is being analyzed. /// - /// pub: PubStatus (optional) + /// * `pub: PubStatus (optional)` /// /// The current status of pub execution, indicating whether we are /// currently running pub. @@ -370,13 +370,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file for which errors are being requested. /// /// Returns /// - /// errors: List + /// * `errors: List` /// /// The errors associated with the file. Future sendAnalysisGetErrors(String file) async { @@ -399,17 +399,17 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which hover information is being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset for which hover information is being requested. /// /// Returns /// - /// hovers: List + /// * `hovers: List` /// /// The hover information associated with the location. The list will be /// empty if no information could be determined for the location. The list @@ -444,23 +444,23 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which import information is being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the region for which import information is being /// requested. /// - /// length: int + /// * `length: int` /// /// The length of the region for which import information is being /// requested. /// /// Returns /// - /// elements: List + /// * `elements: List` /// /// The information about the elements that are referenced in the specified /// region of the specified file that come from imported libraries. @@ -492,12 +492,12 @@ abstract class IntegrationTest { /// /// Returns /// - /// libraries: List + /// * `libraries: List` /// /// A list of the paths of library elements referenced by files in existing /// analysis roots. /// - /// packageMap: Map>> + /// * `packageMap: Map>>` /// /// A mapping from context source roots to package maps which map package /// names to source directories for use in client-side package URI @@ -536,33 +536,33 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which navigation information is being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the region for which navigation information is being /// requested. /// - /// length: int + /// * `length: int` /// /// The length of the region for which navigation information is being /// requested. /// /// Returns /// - /// files: List + /// * `files: List` /// /// A list of the paths of files that are referenced by the navigation /// targets. /// - /// targets: List + /// * `targets: List` /// /// A list of the navigation targets that are referenced by the navigation /// regions. /// - /// regions: List + /// * `regions: List` /// /// A list of the navigation regions within the requested region of the /// file. @@ -595,13 +595,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file for which reachable source information is being requested. /// /// Returns /// - /// sources: Map> + /// * `sources: Map>` /// /// A mapping from source URIs to directly reachable source URIs. For /// example, a file "foo.dart" that imports "bar.dart" would have the @@ -647,26 +647,26 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which signature information is being requested. /// - /// offset: int + /// * `offset: int` /// /// The location for which signature information is being requested. /// /// Returns /// - /// name: String + /// * `name: String` /// /// The name of the function being invoked at the given offset. /// - /// parameters: List + /// * `parameters: List` /// /// A list of information about each of the parameters of the function /// being invoked. /// - /// dartdoc: String (optional) + /// * `dartdoc: String (optional)` /// /// The dartdoc associated with the function being invoked. Other than the /// removal of the comment delimiters, including leading asterisks in the @@ -726,16 +726,16 @@ abstract class IntegrationTest { /// /// Parameters /// - /// included: List + /// * `included: List` /// /// A list of the files and directories that should be analyzed. /// - /// excluded: List + /// * `excluded: List` /// /// A list of the files and directories within the included directories /// that should not be analyzed. /// - /// packageRoots: Map (optional) + /// * `packageRoots: Map (optional)` /// /// A mapping from source directories to package roots that should override /// the normal package: URI resolution mechanism. @@ -774,7 +774,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// subscriptions: List + /// * `subscriptions: List` /// /// A list of the services being subscribed to. Future sendAnalysisSetGeneralSubscriptions( @@ -807,7 +807,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// files: List + /// * `files: List` /// /// The files that are to be a priority for analysis. Future sendAnalysisSetPriorityFiles(List files) async { @@ -844,7 +844,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// subscriptions: Map> + /// * `subscriptions: Map>` /// /// A table mapping services to a list of the files being subscribed to the /// service. @@ -867,8 +867,8 @@ abstract class IntegrationTest { /// /// Parameters /// - /// files: Map + /// * `files: Map` /// /// A table mapping the files whose content has changed to a description of /// the content change. @@ -900,7 +900,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// options: AnalysisOptions + /// * `options: AnalysisOptions` /// /// The options that are to be used to control analysis. // TODO(srawlins): Provide a deprecation message, or remove. @@ -922,7 +922,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// directories: List + /// * `directories: List` /// /// A list of the paths of the files that are being analyzed. late final Stream onAnalysisAnalyzedFiles = @@ -940,11 +940,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file the closing labels relate to. /// - /// labels: List + /// * `labels: List` /// /// Closing labels relevant to the file. Each item represents a useful /// label associated with some range which may be useful to display to the @@ -966,11 +966,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the errors. /// - /// errors: List + /// * `errors: List` /// /// The errors contained in the file. late final Stream onAnalysisErrors = _onAnalysisErrors @@ -995,7 +995,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// files: List + /// * `files: List` /// /// The files that are no longer being analyzed. late final Stream onAnalysisFlushResults = @@ -1017,11 +1017,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the folding regions. /// - /// regions: List + /// * `regions: List` /// /// The folding regions contained in the file. late final Stream onAnalysisFolding = @@ -1040,11 +1040,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the highlight regions. /// - /// regions: List + /// * `regions: List` /// /// The highlight regions contained in the file. Each highlight region /// represents a particular syntactic or semantic meaning associated with @@ -1068,15 +1068,15 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file with which the implementations are associated. /// - /// classes: List + /// * `classes: List` /// /// The classes defined in the file that are implemented or extended. /// - /// members: List + /// * `members: List` /// /// The members defined in the file that are implemented or overridden. late final Stream onAnalysisImplemented = @@ -1096,19 +1096,19 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file whose information has been invalidated. /// - /// offset: int + /// * `offset: int` /// /// The offset of the invalidated region. /// - /// length: int + /// * `length: int` /// /// The length of the invalidated region. /// - /// delta: int + /// * `delta: int` /// /// The delta to be applied to the offsets in information that follows the /// invalidated region in order to update it so that it doesn't need to be @@ -1129,11 +1129,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the navigation regions. /// - /// regions: List + /// * `regions: List` /// /// The navigation regions contained in the file. The regions are sorted by /// their offsets. Each navigation region represents a list of targets @@ -1143,12 +1143,12 @@ abstract class IntegrationTest { /// versions of a package. Note that the navigation regions that are /// returned do not overlap other navigation regions. /// - /// targets: List + /// * `targets: List` /// /// The navigation targets referenced in the file. They are referenced by /// `NavigationRegion`s by their index in this array. /// - /// files: List + /// * `files: List` /// /// The files containing navigation targets referenced in the file. They /// are referenced by `NavigationTarget`s by their index in this array. @@ -1168,11 +1168,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which the references occur. /// - /// occurrences: List + /// * `occurrences: List` /// /// The occurrences of references to elements within the file. late final Stream onAnalysisOccurrences = @@ -1191,15 +1191,15 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file with which the outline is associated. /// - /// kind: FileKind + /// * `kind: FileKind` /// /// The kind of the file. /// - /// libraryName: String (optional) + /// * `libraryName: String (optional)` /// /// The name of the library defined by the file using a "library" /// directive, or referenced by a "part of" directive. If both "library" @@ -1207,7 +1207,7 @@ abstract class IntegrationTest { /// takes precedence. This field will be omitted if the file has neither /// "library" nor "part of" directives. /// - /// outline: Outline + /// * `outline: Outline` /// /// The outline associated with the file. late final Stream onAnalysisOutline = @@ -1226,11 +1226,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file with which the overrides are associated. /// - /// overrides: List + /// * `overrides: List` /// /// The overrides associated with the file. late final Stream onAnalysisOverrides = @@ -1247,28 +1247,28 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the point at which suggestions are to be made. /// - /// offset: int + /// * `offset: int` /// /// The offset within the file at which suggestions are to be made. /// - /// maxResults: int + /// * `maxResults: int` /// /// The maximum number of suggestions to return. If the number of /// suggestions after filtering is greater than the `maxResults`, then /// `isIncomplete` is set to `true`. /// - /// completionCaseMatchingMode: CompletionCaseMatchingMode (optional) + /// * `completionCaseMatchingMode: CompletionCaseMatchingMode (optional)` /// /// The mode of code completion being invoked. If no value is provided, /// `MATCH_FIRST_CHAR` will be assumed. /// /// Returns /// - /// replacementOffset: int + /// * `replacementOffset: int` /// /// The offset of the start of the text to be replaced. This will be /// different from the offset used to request the completion suggestions if @@ -1276,14 +1276,14 @@ abstract class IntegrationTest { /// particular, the replacementOffset will be the offset of the beginning /// of said identifier. /// - /// replacementLength: int + /// * `replacementLength: int` /// /// The length of the text to be replaced if the remainder of the /// identifier containing the cursor is to be replaced when the suggestion /// is applied (that is, the number of characters in the existing /// identifier). /// - /// suggestions: List + /// * `suggestions: List` /// /// The completion suggestions being reported. This list is filtered by the /// already existing prefix, and sorted first by relevance, and (if the @@ -1296,7 +1296,7 @@ abstract class IntegrationTest { /// libraries. Items from not yet imported libraries will have /// `isNotImported` set to `true`. /// - /// isIncomplete: bool + /// * `isIncomplete: bool` /// /// True if the number of suggestions after filtering was greater than the /// requested `maxResults`. @@ -1338,7 +1338,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// paths: List + /// * `paths: List` /// /// A list of objects each containing a path and the additional libraries /// from which the client is interested in receiving completion @@ -1367,35 +1367,35 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The path of the file into which this completion is being inserted. /// - /// offset: int + /// * `offset: int` /// /// The offset in the file where the completion will be inserted. /// - /// completion: String + /// * `completion: String` /// /// The `completion` from the selected `CompletionSuggestion`. It could be /// a name of a class, or a name of a constructor in the form /// "typeName.constructorName()", or an enumeration constant in the form /// "enumName.constantName", etc. /// - /// libraryUri: String + /// * `libraryUri: String` /// /// The URI of the library to import, so that the element referenced in the /// `completion` becomes accessible. /// /// Returns /// - /// completion: String + /// * `completion: String` /// /// The full text to insert, which possibly includes now an import prefix. /// The client should insert this text, not the `completion` from the /// selected `CompletionSuggestion`. /// - /// change: SourceChange + /// * `change: SourceChange` /// /// A change for the client to apply to make the accepted completion /// suggestion available. In most cases the change is to add a new import @@ -1429,11 +1429,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The defining file of the library. /// - /// imports: ExistingImports + /// * `imports: ExistingImports` /// /// The existing imports in the library. late final Stream @@ -1452,23 +1452,23 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the declaration of or reference to the element used /// to define the search. /// - /// offset: int + /// * `offset: int` /// /// The offset within the file of the declaration of or reference to the /// element. /// - /// includePotential: bool + /// * `includePotential: bool` /// /// True if potential matches are to be included in the results. /// /// Returns /// - /// id: SearchId (optional) + /// * `id: SearchId (optional)` /// /// The identifier used to associate results with this search request. /// @@ -1476,7 +1476,7 @@ abstract class IntegrationTest { /// absent, and no results will be reported via the search.results /// notification. /// - /// element: Element (optional) + /// * `element: Element (optional)` /// /// The element referenced or defined at the given offset and whose /// references will be returned in the search results. @@ -1511,13 +1511,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// name: String + /// * `name: String` /// /// The name of the declarations to be found. /// /// Returns /// - /// id: SearchId + /// * `id: SearchId` /// /// The identifier used to associate results with this search request. Future sendSearchFindMemberDeclarations( @@ -1546,13 +1546,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// name: String + /// * `name: String` /// /// The name of the references to be found. /// /// Returns /// - /// id: SearchId + /// * `id: SearchId` /// /// The identifier used to associate results with this search request. Future sendSearchFindMemberReferences( @@ -1580,14 +1580,14 @@ abstract class IntegrationTest { /// /// Parameters /// - /// pattern: String + /// * `pattern: String` /// /// The regular expression used to match the names of the declarations to /// be found. /// /// Returns /// - /// id: SearchId + /// * `id: SearchId` /// /// The identifier used to associate results with this search request. Future @@ -1609,28 +1609,28 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath (optional) + /// * `file: FilePath (optional)` /// /// If this field is provided, return only declarations in this file. If /// this field is missing, return declarations in all files. /// - /// pattern: String (optional) + /// * `pattern: String (optional)` /// /// The regular expression used to match the names of declarations. If this /// field is missing, return all declarations. /// - /// maxResults: int (optional) + /// * `maxResults: int (optional)` /// /// The maximum number of declarations to return. If this field is missing, /// return all matching declarations. /// /// Returns /// - /// declarations: List + /// * `declarations: List` /// /// The list of declarations. /// - /// files: List + /// * `files: List` /// /// The list of the paths of files with declarations. Future sendSearchGetElementDeclarations({ @@ -1658,23 +1658,23 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the declaration or reference to the type for which /// a hierarchy is being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the name of the type within the file. /// - /// superOnly: bool (optional) + /// * `superOnly: bool (optional)` /// /// True if the client is only requesting superclasses and interfaces /// hierarchy. /// /// Returns /// - /// hierarchyItems: List (optional) + /// * `hierarchyItems: List (optional)` /// /// A list of the types in the requested hierarchy. The first element of /// the list is the item representing the type for which the hierarchy was @@ -1712,15 +1712,15 @@ abstract class IntegrationTest { /// /// Parameters /// - /// id: SearchId + /// * `id: SearchId` /// /// The id associated with the search. /// - /// results: List + /// * `results: List` /// /// The search results being reported. /// - /// isLast: bool + /// * `isLast: bool` /// /// True if this is that last set of results that will be returned for the /// indicated search. @@ -1747,19 +1747,19 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code to be formatted. /// - /// selectionOffset: int + /// * `selectionOffset: int` /// /// The offset of the current selection in the file. /// - /// selectionLength: int + /// * `selectionLength: int` /// /// The length of the current selection in the file. /// - /// lineLength: int (optional) + /// * `lineLength: int (optional)` /// /// The line length to be used by the formatter. This value is ignored if a /// `formatter.page_width` has been configured in the relevant @@ -1767,16 +1767,16 @@ abstract class IntegrationTest { /// /// Returns /// - /// edits: List + /// * `edits: List` /// /// The edit(s) to be applied in order to format the code. The list will be /// empty if the code was already formatted (there are no changes). /// - /// selectionOffset: int + /// * `selectionOffset: int` /// /// The offset of the selection after formatting the code. /// - /// selectionLength: int + /// * `selectionLength: int` /// /// The length of the selection after formatting the code. Future sendEditFormat( @@ -1812,13 +1812,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// directories: List + /// * `directories: List` /// /// The paths of the directories containing the code to be formatted. /// /// Returns /// - /// edits: List + /// * `edits: List` /// /// The edit(s) to be applied in order to format the code. The list will be /// empty if none of the files were formatted, whether because they were @@ -1846,21 +1846,21 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code for which assists are being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the code for which assists are being requested. /// - /// length: int + /// * `length: int` /// /// The length of the code for which assists are being requested. /// /// Returns /// - /// assists: List + /// * `assists: List` /// /// The assists that are available at the given location. Future sendEditGetAssists( @@ -1888,21 +1888,21 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code on which the refactoring would be based. /// - /// offset: int + /// * `offset: int` /// /// The offset of the code on which the refactoring would be based. /// - /// length: int + /// * `length: int` /// /// The length of the code on which the refactoring would be based. /// /// Returns /// - /// kinds: List + /// * `kinds: List` /// /// The kinds of refactorings that are valid for the given selection. Future sendEditGetAvailableRefactorings( @@ -1932,7 +1932,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// included: List + /// * `included: List` /// /// A list of the files and directories for which edits should be /// suggested. @@ -1945,7 +1945,7 @@ abstract class IntegrationTest { /// analysis.setAnalysisRoots), an error of type `FILE_NOT_ANALYZED` will /// be generated. /// - /// inTestMode: bool (optional) + /// * `inTestMode: bool (optional)` /// /// A flag indicating whether the bulk fixes are being run in test mode. /// The only difference is that in test mode the fix processor will look @@ -1954,7 +1954,7 @@ abstract class IntegrationTest { /// /// If this field is omitted the flag defaults to `false`. /// - /// updatePubspec: bool (optional) + /// * `updatePubspec: bool (optional)` /// /// A flag indicating whether to validate that the dependencies used by the /// included files are listed in the pubspec file. If specified, the fix @@ -1964,21 +1964,21 @@ abstract class IntegrationTest { /// /// If this field is omitted the flag defaults to `false`. /// - /// codes: List (optional) + /// * `codes: List (optional)` /// /// A list of diagnostic codes to be fixed. /// /// Returns /// - /// message: String + /// * `message: String` /// /// An optional message explaining unapplied fixes. /// - /// edits: List + /// * `edits: List` /// /// A list of source edits to apply the recommended changes. /// - /// details: List + /// * `details: List` /// /// Details that summarize the fixes associated with the recommended /// changes. @@ -2014,17 +2014,17 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the errors for which fixes are being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset used to select the errors for which fixes will be returned. /// /// Returns /// - /// fixes: List + /// * `fixes: List` /// /// The fixes that are available for the errors at the given offset. Future sendEditGetFixes(String file, int offset) async { @@ -2047,22 +2047,22 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the postfix template to be expanded. /// - /// key: String + /// * `key: String` /// /// The unique name that identifies the template in use. /// - /// offset: int + /// * `offset: int` /// /// The offset used to identify the code to which the template will be /// applied. /// /// Returns /// - /// change: SourceChange + /// * `change: SourceChange` /// /// The change to be applied in order to complete the statement. Future sendEditGetPostfixCompletion( @@ -2092,28 +2092,28 @@ abstract class IntegrationTest { /// /// Parameters /// - /// kind: RefactoringKind + /// * `kind: RefactoringKind` /// /// The kind of refactoring to be performed. /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code involved in the refactoring. /// - /// offset: int + /// * `offset: int` /// /// The offset of the region involved in the refactoring. /// - /// length: int + /// * `length: int` /// /// The length of the region involved in the refactoring. /// - /// validateOnly: bool + /// * `validateOnly: bool` /// /// True if the client is only requesting that the values of the options be /// validated and no change be generated. /// - /// options: RefactoringOptions (optional) + /// * `options: RefactoringOptions (optional)` /// /// Data used to provide values provided by the user. The structure of the /// data is dependent on the kind of refactoring being performed. The data @@ -2124,39 +2124,39 @@ abstract class IntegrationTest { /// /// Returns /// - /// initialProblems: List + /// * `initialProblems: List` /// /// The initial status of the refactoring, i.e. problems related to the /// context in which the refactoring is requested. The array will be empty /// if there are no known problems. /// - /// optionsProblems: List + /// * `optionsProblems: List` /// /// The options validation status, i.e. problems in the given options, such /// as light-weight validation of a new name, flags compatibility, etc. The /// array will be empty if there are no known problems. /// - /// finalProblems: List + /// * `finalProblems: List` /// /// The final status of the refactoring, i.e. problems identified in the /// result of a full, potentially expensive validation and / or change /// creation. The array will be empty if there are no known problems. /// - /// feedback: RefactoringFeedback (optional) + /// * `feedback: RefactoringFeedback (optional)` /// /// Data used to provide feedback to the user. The structure of the data is /// dependent on the kind of refactoring being created. The data that is /// returned is documented in the section titled Refactorings, labeled as /// "Feedback". /// - /// change: SourceChange (optional) + /// * `change: SourceChange (optional)` /// /// The changes that are to be applied to affect the refactoring. This /// field will be omitted if there are problems that prevent a set of /// changes from being computed, such as having no options specified for a /// refactoring that requires them, or if only validation was requested. /// - /// potentialEdits: List (optional) + /// * `potentialEdits: List (optional)` /// /// The ids of source edits that are not known to be valid. An edit is not /// known to be valid if there was insufficient type information for the @@ -2201,21 +2201,21 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the statement to be completed. /// - /// offset: int + /// * `offset: int` /// /// The offset used to identify the statement to be completed. /// /// Returns /// - /// change: SourceChange + /// * `change: SourceChange` /// /// The change to be applied in order to complete the statement. /// - /// whitespaceOnly: bool + /// * `whitespaceOnly: bool` /// /// Will be true if the change contains nothing but whitespace characters, /// or is empty. @@ -2242,22 +2242,22 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the postfix template to be expanded. /// - /// key: String + /// * `key: String` /// /// The unique name that identifies the template in use. /// - /// offset: int + /// * `offset: int` /// /// The offset used to identify the code to which the template will be /// applied. /// /// Returns /// - /// value: bool + /// * `value: bool` /// /// True if the template can be expanded at the given location. Future @@ -2288,7 +2288,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// templates: List + /// * `templates: List` /// /// The list of available templates. Future @@ -2314,15 +2314,15 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which the specified elements are to be made accessible. /// - /// elements: List + /// * `elements: List` /// /// The elements to be made accessible in the specified file. /// - /// offset: int (optional) + /// * `offset: int (optional)` /// /// The offset at which the specified elements need to be made accessible. /// If provided, this is used to guard against adding imports for text that @@ -2331,7 +2331,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// edit: SourceFileEdit (optional) + /// * `edit: SourceFileEdit (optional)` /// /// The edits to be applied in order to make the specified elements /// accessible. The file to be edited will be the defining compilation unit @@ -2371,13 +2371,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The Dart file to sort. /// /// Returns /// - /// edit: SourceFileEdit + /// * `edit: SourceFileEdit` /// /// The file edit that is to be applied to the given file to affect the /// sorting. @@ -2409,13 +2409,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The Dart file to organize directives in. /// /// Returns /// - /// edit: SourceFileEdit + /// * `edit: SourceFileEdit` /// /// The file edit that is to be applied to the given file to affect the /// organizing. @@ -2442,14 +2442,14 @@ abstract class IntegrationTest { /// /// Parameters /// - /// contextRoot: FilePath + /// * `contextRoot: FilePath` /// /// The path of the Dart or HTML file that will be launched, or the path of /// the directory containing the file. /// /// Returns /// - /// id: ExecutionContextId + /// * `id: ExecutionContextId` /// /// The identifier used to refer to the execution context that was created. Future sendExecutionCreateContext( @@ -2474,7 +2474,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// id: ExecutionContextId + /// * `id: ExecutionContextId` /// /// The identifier of the execution context that is to be deleted. Future sendExecutionDeleteContext(String id) async { @@ -2502,32 +2502,32 @@ abstract class IntegrationTest { /// /// Parameters /// - /// code: String + /// * `code: String` /// /// The code to get suggestions in. /// - /// offset: int + /// * `offset: int` /// /// The offset within the code to get suggestions at. /// - /// contextFile: FilePath + /// * `contextFile: FilePath` /// /// The path of the context file, e.g. the file of the current debugger /// frame. The combination of the context file and context offset can be /// used to ensure that all variables of the context are available for /// completion (with their static types). /// - /// contextOffset: int + /// * `contextOffset: int` /// /// The offset in the context file, e.g. the line offset in the current /// debugger frame. /// - /// variables: List + /// * `variables: List` /// /// The runtime context variables that are potentially referenced in the /// code. /// - /// expressions: List (optional) + /// * `expressions: List (optional)` /// /// The list of sub-expressions in the code for which the client wants to /// provide runtime types. It does not have to be the full list of @@ -2541,7 +2541,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// suggestions: List (optional) + /// * `suggestions: List (optional)` /// /// The completion suggestions. In contrast to usual completion requests, /// suggestions for private elements also will be provided. @@ -2552,7 +2552,7 @@ abstract class IntegrationTest { /// server omits this field in the response, and instead will return the /// "expressions" field. /// - /// expressions: List (optional) + /// * `expressions: List (optional)` /// /// The list of sub-expressions in the code for which the server would like /// to know runtime types to provide better completion suggestions. @@ -2607,27 +2607,27 @@ abstract class IntegrationTest { /// /// Parameters /// - /// id: ExecutionContextId + /// * `id: ExecutionContextId` /// /// The identifier of the execution context in which the URI is to be /// mapped. /// - /// file: FilePath (optional) + /// * `file: FilePath (optional)` /// /// The path of the file to be mapped into a URI. /// - /// uri: String (optional) + /// * `uri: String (optional)` /// /// The URI to be mapped into a file path. /// /// Returns /// - /// file: FilePath (optional) + /// * `file: FilePath (optional)` /// /// The file to which the URI was mapped. This field is omitted if the uri /// field was not given in the request. /// - /// uri: String (optional) + /// * `uri: String (optional)` /// /// The URI to which the file path was mapped. This field is omitted if the /// file field was not given in the request. @@ -2662,7 +2662,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// subscriptions: List + /// * `subscriptions: List` /// /// A list of the services being subscribed to. // TODO(srawlins): Provide a deprecation message, or remove. @@ -2686,17 +2686,17 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file for which launch data is being provided. This will either be a /// Dart library or an HTML file. /// - /// kind: ExecutableKind (optional) + /// * `kind: ExecutableKind (optional)` /// /// The kind of the executable file. This field is omitted if the file is /// not a Dart file. /// - /// referencedFiles: List (optional) + /// * `referencedFiles: List (optional)` /// /// A list of the Dart files that are referenced by the file. This field is /// omitted if the file is not an HTML file. @@ -2712,7 +2712,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// contexts: List + /// * `contexts: List` /// /// The list of analysis contexts. Future sendDiagnosticGetDiagnostics() async { @@ -2733,7 +2733,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// port: int + /// * `port: int` /// /// The diagnostic server port. Future sendDiagnosticGetServerPort() async { @@ -2766,7 +2766,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// enabled: bool + /// * `enabled: bool` /// /// Whether sending analytics is enabled or not. // TODO(srawlins): Provide a deprecation message, or remove. @@ -2793,7 +2793,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// value: bool + /// * `value: bool` /// /// Enable or disable analytics. // TODO(srawlins): Provide a deprecation message, or remove. @@ -2822,7 +2822,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// action: String + /// * `action: String` /// /// The value used to indicate which action was performed. Future sendAnalyticsSendEvent(String action) async { @@ -2847,11 +2847,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// event: String + /// * `event: String` /// /// The name of the event. /// - /// millis: int + /// * `millis: int` /// /// The duration of the event in milliseconds. Future sendAnalyticsSendTiming(String event, int millis) async { @@ -2874,17 +2874,17 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file where the widget instance is created. /// - /// offset: int + /// * `offset: int` /// /// The offset in the file where the widget instance is created. /// /// Returns /// - /// properties: List + /// * `properties: List` /// /// The list of properties of the widget. Some of the properties might be /// read only, when their `editor` is not set. This might be because they @@ -2918,7 +2918,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// id: int + /// * `id: int` /// /// The identifier of the property, previously returned as a part of a /// `FlutterWidgetProperty`. @@ -2926,7 +2926,7 @@ abstract class IntegrationTest { /// An error of type `FLUTTER_SET_WIDGET_PROPERTY_VALUE_INVALID_ID` is /// generated if the identifier is not valid. /// - /// value: FlutterWidgetPropertyValue (optional) + /// * `value: FlutterWidgetPropertyValue (optional)` /// /// The new value to set for the property. /// @@ -2940,7 +2940,7 @@ abstract class IntegrationTest { /// /// Returns /// - /// change: SourceChange + /// * `change: SourceChange` /// /// The change that should be applied. Future sendFlutterSetWidgetPropertyValue( @@ -2987,7 +2987,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// subscriptions: Map> + /// * `subscriptions: Map>` /// /// A table mapping services to a list of the files being subscribed to the /// service. @@ -3009,11 +3009,11 @@ abstract class IntegrationTest { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file with which the outline is associated. /// - /// outline: FlutterOutline + /// * `outline: FlutterOutline` /// /// The outline associated with the file. late final Stream onFlutterOutline = _onFlutterOutline @@ -3032,13 +3032,13 @@ abstract class IntegrationTest { /// /// Parameters /// - /// lspMessage: object + /// * `lspMessage: object` /// /// The LSP RequestMessage. /// /// Returns /// - /// lspResponse: object + /// * `lspResponse: object` /// /// The LSP ResponseMessage returned by the handler. Future sendLspHandle(Object lspMessage) async { @@ -3059,7 +3059,7 @@ abstract class IntegrationTest { /// /// Parameters /// - /// lspNotification: object + /// * `lspNotification: object` /// /// The LSP NotificationMessage sent by the server. late final Stream onLspNotification = diff --git a/pkg/analysis_server/lib/src/server/driver.dart b/pkg/analysis_server/lib/src/server/driver.dart index ef2bb0a44f6..f3ca1ac558e 100644 --- a/pkg/analysis_server/lib/src/server/driver.dart +++ b/pkg/analysis_server/lib/src/server/driver.dart @@ -105,7 +105,7 @@ class Driver implements ServerStarter { /// The option for specifying the http diagnostic port. /// If specified, users can review server status and performance information - /// by opening a web browser on http://localhost: + /// by opening a web browser on `http://localhost:`. static const String DIAGNOSTIC_PORT = 'diagnostic-port'; static const String DIAGNOSTIC_PORT_ALIAS = 'port'; diff --git a/pkg/analysis_server/lib/src/server/sdk_configuration.dart b/pkg/analysis_server/lib/src/server/sdk_configuration.dart index d9dd41b8d97..050c8d25a2b 100644 --- a/pkg/analysis_server/lib/src/server/sdk_configuration.dart +++ b/pkg/analysis_server/lib/src/server/sdk_configuration.dart @@ -24,7 +24,7 @@ class SdkConfiguration { } /// Create an SDK configuration based on any SDK configuration file at - /// /config/settings.json. + /// `/config/settings.json`. /// /// This constructor will still create an object even if a configuration file /// is not found. diff --git a/pkg/analysis_server/lib/src/services/correction/fix/data_driven/code_fragment_parser.dart b/pkg/analysis_server/lib/src/services/correction/fix/data_driven/code_fragment_parser.dart index 09eb137f22d..91ea02b5483 100644 --- a/pkg/analysis_server/lib/src/services/correction/fix/data_driven/code_fragment_parser.dart +++ b/pkg/analysis_server/lib/src/services/correction/fix/data_driven/code_fragment_parser.dart @@ -49,8 +49,8 @@ class CodeFragmentParser { /// Parse the [content] into a list of accessors. Add the [delta] to translate /// from offsets within the content to offsets within the file. /// - /// ::= - /// ('.' )* + /// ::= + /// ('.' )* List? parseAccessors(String content, int delta) { this.delta = delta; var scannedTokens = _CodeFragmentScanner( @@ -98,8 +98,8 @@ class CodeFragmentParser { /// Parse the [content] into a condition. Add the [delta] to translate /// from offsets within the content to offsets within the file. /// - /// ::= - /// + /// ::= + /// Expression? parseCondition(String content, int delta) { this.delta = delta; var scannedTokens = _CodeFragmentScanner( @@ -176,8 +176,8 @@ class CodeFragmentParser { /// Parse an accessor. /// - /// ::= - /// '[' ( | ) ']' + /// ::= + /// '[' ( | ) ']' Accessor? _parseAccessor() { var token = _expect(const [_TokenKind.identifier]); if (token == null) { @@ -248,10 +248,10 @@ class CodeFragmentParser { /// Parse a logical expression. /// - /// ::= - /// ( )? - /// ::= - /// '==' | '!=' + /// ::= + /// ( )? + /// ::= + /// '==' | '!=' Expression? _parseEqualityExpression() { var expression = _parsePrimaryExpression(); if (expression == null) { @@ -277,8 +277,8 @@ class CodeFragmentParser { /// Parse a logical expression. /// - /// ::= - /// ('&&' )* + /// ::= + /// ('&&' )* Expression? _parseLogicalAndExpression() { var leftOperand = _parseEqualityExpression(); if (leftOperand == null) { @@ -306,8 +306,8 @@ class CodeFragmentParser { /// Parse a logical expression. /// - /// ::= - /// | + /// ::= + /// | Expression? _parsePrimaryExpression() { var token = _currentToken; if (token != null) { diff --git a/pkg/analysis_server/lib/src/services/kythe/kythe_visitors.dart b/pkg/analysis_server/lib/src/services/kythe/kythe_visitors.dart index b1df8687983..256c8dc9dc2 100644 --- a/pkg/analysis_server/lib/src/services/kythe/kythe_visitors.dart +++ b/pkg/analysis_server/lib/src/services/kythe/kythe_visitors.dart @@ -11,7 +11,7 @@ import 'schema.dart' as schema; /// Returns the name of the [constructor]. /// -/// This is either '' or '.', +/// This is either `` or `.`, /// depending on whether the constructor is a named constructor. String _computeConstructorElementName(ConstructorElement constructor) { var name = constructor.enclosingElement.name!; diff --git a/pkg/analysis_server/lib/src/utilities/stream_string_stink.dart b/pkg/analysis_server/lib/src/utilities/stream_string_stink.dart index cba0ee68c28..0dc1fc5b1c5 100644 --- a/pkg/analysis_server/lib/src/utilities/stream_string_stink.dart +++ b/pkg/analysis_server/lib/src/utilities/stream_string_stink.dart @@ -4,7 +4,7 @@ import 'dart:async'; -/// A [StringSink] that writes into a StreamSink. +/// A [StringSink] that writes into a `StreamSink`. class StreamStringSink implements StringSink { final StreamSink _sink; diff --git a/pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart b/pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart index 93eec541631..88602e4e6c7 100644 --- a/pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart +++ b/pkg/analyzer_plugin/test/integration/support/integration_test_methods.dart @@ -28,46 +28,46 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// byteStorePath: FilePath + /// * `byteStorePath: FilePath` /// /// The path to the directory containing the on-disk byte store that is to /// be used by any analysis drivers that are created. /// - /// sdkPath: FilePath + /// * `sdkPath: FilePath` /// /// The path to the directory containing the SDK that is to be used by any /// analysis drivers that are created. /// - /// version: String + /// * `version: String` /// /// The version number of the plugin spec supported by the analysis server /// that is executing the plugin. /// /// Returns /// - /// isCompatible: bool + /// * `isCompatible: bool` /// /// A flag indicating whether the plugin supports the same version of the /// plugin spec as the analysis server. If the value is `false`, then the /// plugin is expected to shutdown after returning the response. /// - /// name: String + /// * `name: String` /// /// The name of the plugin. This value is only used when the server needs /// to identify the plugin, either to the user or for debugging purposes. /// - /// version: String + /// * `version: String` /// /// The version of the plugin. This value is only used when the server /// needs to identify the plugin, either to the user or for debugging /// purposes. /// - /// contactInfo: String (optional) + /// * `contactInfo: String (optional)` /// /// Information that the user can use to use to contact the maintainers of /// the plugin when there is a problem. /// - /// interestingFiles: List + /// * `interestingFiles: List` /// /// The glob patterns of the files for which the plugin will provide /// information. This value is ignored if the `isCompatible` field is @@ -93,7 +93,7 @@ abstract class IntegrationTestMixin { /// /// Returns /// - /// plugins: List + /// * `plugins: List` /// /// A list of the details of all registered plugins. Future sendPluginDetails() async { @@ -119,18 +119,18 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// isFatal: bool + /// * `isFatal: bool` /// /// A flag indicating whether the error is a fatal error, meaning that the /// plugin will shutdown automatically after sending this notification. If /// `true`, the server will not expect any other responses or notifications /// from the plugin. /// - /// message: String + /// * `message: String` /// /// The error message indicating what kind of error was encountered. /// - /// stackTrace: String + /// * `stackTrace: String` /// /// The stack trace associated with the generation of the error, used for /// debugging the plugin. @@ -147,7 +147,7 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// analysis: AnalysisStatus (optional) + /// * `analysis: AnalysisStatus (optional)` /// /// The current status of analysis (whether analysis is being performed). late Stream onPluginStatus; @@ -172,33 +172,33 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which navigation information is being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the region for which navigation information is being /// requested. /// - /// length: int + /// * `length: int` /// /// The length of the region for which navigation information is being /// requested. /// /// Returns /// - /// files: List + /// * `files: List` /// /// A list of the paths of files that are referenced by the navigation /// targets. /// - /// targets: List + /// * `targets: List` /// /// A list of the navigation targets that are referenced by the navigation /// regions. /// - /// regions: List + /// * `regions: List` /// /// A list of the navigation regions within the requested region of the /// file. @@ -219,7 +219,7 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// events: List + /// * `events: List` /// /// The watch events that the plugin should handle. Future sendAnalysisHandleWatchEvents(List events) async { @@ -233,7 +233,7 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// roots: List + /// * `roots: List` /// /// A list of the context roots that should be analyzed. Future sendAnalysisSetContextRoots(List roots) async { @@ -253,7 +253,7 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// files: List + /// * `files: List` /// /// The files that are to be a priority for analysis. Future sendAnalysisSetPriorityFiles(List files) async { @@ -272,7 +272,7 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// subscriptions: Map> + /// * `subscriptions: Map>` /// /// A table mapping services to a list of the files being subscribed to the /// service. @@ -294,8 +294,8 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// files: Map + /// * `files: Map` /// /// A table mapping the files whose content has changed to a description of /// the content change. @@ -312,11 +312,11 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the errors. /// - /// errors: List + /// * `errors: List` /// /// The errors contained in the file. late Stream onAnalysisErrors; @@ -339,11 +339,11 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the folding regions. /// - /// regions: List + /// * `regions: List` /// /// The folding regions contained in the file. late Stream onAnalysisFolding; @@ -363,11 +363,11 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the highlight regions. /// - /// regions: List + /// * `regions: List` /// /// The highlight regions contained in the file. late Stream onAnalysisHighlights; @@ -394,20 +394,20 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the navigation regions. /// - /// regions: List + /// * `regions: List` /// /// The navigation regions contained in the file. /// - /// targets: List + /// * `targets: List` /// /// The navigation targets referenced in the file. They are referenced by /// NavigationRegions by their index in this array. /// - /// files: List + /// * `files: List` /// /// The files containing navigation targets referenced in the file. They /// are referenced by NavigationTargets by their index in this array. @@ -430,11 +430,11 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file in which the references occur. /// - /// occurrences: List + /// * `occurrences: List` /// /// The occurrences of references to elements within the file. late Stream onAnalysisOccurrences; @@ -454,11 +454,11 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file with which the outline is associated. /// - /// outline: List + /// * `outline: List` /// /// The outline fragments associated with the file. late Stream onAnalysisOutline; @@ -473,17 +473,17 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the point at which suggestions are to be made. /// - /// offset: int + /// * `offset: int` /// /// The offset within the file at which suggestions are to be made. /// /// Returns /// - /// replacementOffset: int + /// * `replacementOffset: int` /// /// The offset of the start of the text to be replaced. This will be /// different than the offset used to request the completion suggestions if @@ -491,14 +491,14 @@ abstract class IntegrationTestMixin { /// particular, the replacementOffset will be the offset of the beginning /// of said identifier. /// - /// replacementLength: int + /// * `replacementLength: int` /// /// The length of the text to be replaced if the remainder of the /// identifier containing the cursor is to be replaced when the suggestion /// is applied (that is, the number of characters in the existing /// identifier). /// - /// results: List + /// * `results: List` /// /// The completion suggestions being reported. The notification contains /// all possible completions at the requested cursor position, even those @@ -522,21 +522,21 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code for which assists are being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset of the code for which assists are being requested. /// - /// length: int + /// * `length: int` /// /// The length of the code for which assists are being requested. /// /// Returns /// - /// assists: List + /// * `assists: List` /// /// The assists that are available at the given location. Future sendEditGetAssists( @@ -555,21 +555,21 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code on which the refactoring would be based. /// - /// offset: int + /// * `offset: int` /// /// The offset of the code on which the refactoring would be based. /// - /// length: int + /// * `length: int` /// /// The length of the code on which the refactoring would be based. /// /// Returns /// - /// kinds: List + /// * `kinds: List` /// /// The kinds of refactorings that are valid for the given selection. /// @@ -601,17 +601,17 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the errors for which fixes are being requested. /// - /// offset: int + /// * `offset: int` /// /// The offset used to select the errors for which fixes will be returned. /// /// Returns /// - /// fixes: List + /// * `fixes: List` /// /// The fixes that are available for the errors at the given offset. Future sendEditGetFixes(String file, int offset) async { @@ -625,28 +625,28 @@ abstract class IntegrationTestMixin { /// /// Parameters /// - /// kind: RefactoringKind + /// * `kind: RefactoringKind` /// /// The kind of refactoring to be performed. /// - /// file: FilePath + /// * `file: FilePath` /// /// The file containing the code involved in the refactoring. /// - /// offset: int + /// * `offset: int` /// /// The offset of the region involved in the refactoring. /// - /// length: int + /// * `length: int` /// /// The length of the region involved in the refactoring. /// - /// validateOnly: bool + /// * `validateOnly: bool` /// /// True if the client is only requesting that the values of the options be /// validated and no change be generated. /// - /// options: RefactoringOptions (optional) + /// * `options: RefactoringOptions (optional)` /// /// Data used to provide values provided by the user. The structure of the /// data is dependent on the kind of refactoring being performed. The data @@ -657,39 +657,39 @@ abstract class IntegrationTestMixin { /// /// Returns /// - /// initialProblems: List + /// * `initialProblems: List` /// /// The initial status of the refactoring, that is, problems related to the /// context in which the refactoring is requested. The list should be empty /// if there are no known problems. /// - /// optionsProblems: List + /// * `optionsProblems: List` /// /// The options validation status, that is, problems in the given options, /// such as light-weight validation of a new name, flags compatibility, /// etc. The list should be empty if there are no known problems. /// - /// finalProblems: List + /// * `finalProblems: List` /// /// The final status of the refactoring, that is, problems identified in /// the result of a full, potentially expensive validation and / or change /// creation. The list should be empty if there are no known problems. /// - /// feedback: RefactoringFeedback (optional) + /// * `feedback: RefactoringFeedback (optional)` /// /// Data used to provide feedback to the user. The structure of the data is /// dependent on the kind of refactoring being created. The data that is /// returned is documented in the section titled Refactorings, labeled as /// "Feedback". /// - /// change: SourceChange (optional) + /// * `change: SourceChange (optional)` /// /// The changes that are to be applied to affect the refactoring. This /// field can be omitted if there are problems that prevent a set of /// changes from being computed, such as having no options specified for a /// refactoring that requires them, or if only validation was requested. /// - /// potentialEdits: List (optional) + /// * `potentialEdits: List (optional)` /// /// The ids of source edits that are not known to be valid. An edit is not /// known to be valid if there was insufficient type information for the diff --git a/pkg/analyzer_utilities/lib/text_formatter.dart b/pkg/analyzer_utilities/lib/text_formatter.dart index 7deda7e04f5..7dadbdf7d42 100644 --- a/pkg/analyzer_utilities/lib/text_formatter.dart +++ b/pkg/analyzer_utilities/lib/text_formatter.dart @@ -74,7 +74,6 @@ class _TextFormatter with CodeGenerator { case 'br': lineBreak(false); case 'dl': - case 'dt': case 'h1': case 'h2': case 'h3': @@ -106,6 +105,10 @@ class _TextFormatter with CodeGenerator { addAll(node.nodes); lineBreak(false); }); + case 'dt': + word += '* `'; + addAll(node.nodes); + word += '`'; case 'dd': lineBreak(true); indent(() {