Skip to content

flutter docs no longer generate cleanly in checked mode #1602

@jcollins-g

Description

@jcollins-g

Tried fixing this quickly but there seem to be several things wrong. It's likely that at least a handful of links are messed up in the generated docs as a result. Found as a result of working on #1600.

build-flutter-docs: Generating docs for library dart._http from package:sky_engine/_http/http.dart...                                                                                                             
build-flutter-docs:   warning: dart._http has no library level documentation comments, from dart._http: (file:///tmp/flutterPHRRYD/bin/cache/pkg/sky_engine/lib/_http/http.dart:5:9)                              
build-flutter-docs:   warning: generic type handled as HTML: """    List<String> values = request.head""", from dart._http.HeaderValue: (file:///tmp/flutterPHRRYD/bin/cache/pkg/sky_engine/lib/_http/http.dart:69
4:16)                                                                                                                                                                                                             
build-flutter-docs:                                                                                                                                                                                               
build-flutter-docs: Generation failed: 'package:dartdoc/src/model.dart': Failed assertion: line 4484 pos 14: 'matches.length <= 1': is not true.                                                                  
build-flutter-docs: dart:core                                                             _AssertionError._throwNew                                                                                               
build-flutter-docs: package:dartdoc/src/model.dart 4484:14                                Package.findCanonicalModelElementFor                                                                                    
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 536:29                    _findRefElementInLibrary                                                                                                
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 263:9                     _getMatchingLinkElement                                                                                                 
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 735:12                    _linkDocReference                                                                                                       
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 984:26                    Documentation._renderMarkdownToHtml._linkResolver                                                                       
build-flutter-docs: package:markdown/src/inline_parser.dart 347:26                        LinkSyntax.createNode                                                                                                   
build-flutter-docs: package:markdown/src/inline_parser.dart 411:16                        LinkSyntax.onMatchEnd                                                                                                   
build-flutter-docs: package:markdown/src/inline_parser.dart 545:16                        TagState.close                                                                                                          
build-flutter-docs: package:markdown/src/inline_parser.dart 506:7                         TagState.tryMatch                                                                                                       
build-flutter-docs: package:markdown/src/inline_parser.dart 99:23                         InlineParser.parse                                                                                                      
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 881:57                    MarkdownDocument._parseInlineContent                                                                                    
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 886:9                     MarkdownDocument._parseInlineContent                                                                                    
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 906:5                     MarkdownDocument.renderLinesToHtml                                                                                      
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 994:21                    Documentation._renderMarkdownToHtml                                                                                     
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 967:9                     Documentation._renderHtmlForDartdoc                                                                                     
build-flutter-docs: package:dartdoc/src/markdown_processor.dart 952:7                     Documentation.asOneLiner                                                                                                
build-flutter-docs: package:dartdoc/src/model.dart 3188:29                                ModelElement.oneLineDoc                                                                                                 
build-flutter-docs: dart:mirrors                                                          _LocalInstanceMirror.getField                                                                                           
build-flutter-docs: package:mustache4dart/src/mirrors.dart 111:35                         _MethodMirrorField.val                                                                                                  
build-flutter-docs: package:mustache4dart/mustache_context.dart 122:45                    _MustacheContext._getMustacheContext                                                                                    
build-flutter-docs: package:mustache4dart/mustache_context.dart 118:12                    _MustacheContext._getContextForKey                                                                                      
build-flutter-docs: package:mustache4dart/mustache_context.dart 82:18                     _MustacheContext._getInThisOrParent                                                                                     
build-flutter-docs: package:mustache4dart/mustache_context.dart 78:12                     _MustacheContext.field                                                                                                  
build-flutter-docs: package:mustache4dart/src/tokens.dart 169:21                          _ExpressionToken.apply                                                                                                  
build-flutter-docs: package:mustache4dart/src/tokens.dart 286:57                          _StartSectionToken.apply.<fn>.<fn>                                                                                      
build-flutter-docs: package:mustache4dart/src/tokens.dart 309:8                           _StartSectionToken.forEachUntilEndSection                                                                               
build-flutter-docs: package:mustache4dart/src/tokens.dart 286:9                           _StartSectionToken.apply.<fn>                                                                                           
build-flutter-docs: dart:core                                                             Iterable.forEach              

Metadata

Metadata

Assignees

Labels

P1A high priority bug; for example, a single project is unusable or has many test failurescustomer-flutterIssues originating from important to Flutter

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions