No proper formatting on Quick Doc

[adamsocrat]

Steps to Reproduce

Quick doc does not serve its purpose. In intellij 2024.1 and later, flutter quickdoc is formatted hardly readeble. Default theme is also been tried, result is the same.

Please tell us what you were doing and what went wrong

In v2024.1 flutter quickdoc:

In v2024.1 other languages quickdoc:

Kotlin	Gradle

In 2023.2.6:

In 2023.3.6 at least it is more readeble. If it indexes and formats the code in quickdoc it would be great.

Version info

[✓] Flutter (Channel stable, 3.19.6, on macOS 14.4.1 23E224 darwin-arm64, locale en-US)
• Flutter version 3.19.6 on channel stable at /Users/.../development/flutter
• Upstream repository https://github.com/flutter/flutter.git
• Framework revision 54e66469a9 (4 weeks ago), 2024-04-17 13:08:03 -0700
• Engine revision c4cd48e186
• Dart version 3.3.4
• DevTools version 2.31.1

[✓] Android toolchain - develop for Android devices (Android SDK version 34.0.0)
• Android SDK at /Users/..../Library/Android/sdk
• Platform android-34, build-tools 34.0.0
• ANDROID_HOME = /Users/..../Library/Android/sdk
• Java binary at: /Users/..../Applications/Android Studio.app/Contents/jbr/Contents/Home/bin/java
• Java version OpenJDK Runtime Environment (build 17.0.10+0-17.0.10b1087.21-11572160)
• All Android licenses accepted.

[✓] Xcode - develop for iOS and macOS (Xcode 15.4)
• Xcode at /Applications/Xcode.app/Contents/Developer
• Build 15F31d
• CocoaPods version 1.14.3

[✓] Chrome - develop for the web
• Chrome at /Applications/Google Chrome.app/Contents/MacOS/Google Chrome

[✓] Android Studio (version 2023.3)
• Android Studio at /Users/..../Applications/Android Studio.app/Contents
• Flutter plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/9212-flutter
• Dart plugin can be installed from:
🔨 https://plugins.jetbrains.com/plugin/6351-dart
• Java version OpenJDK Runtime Environment (build 17.0.10+0-17.0.10b1087.21-11572160)

[✓] IntelliJ IDEA Ultimate Edition (version 2023.2.6)
• IntelliJ at /Users/..../Applications/IntelliJ IDEA Ultimate.app
• Flutter plugin version 79.0.1
• Dart plugin version 232.10313

For other version of IntelliJ
[✓] IntelliJ IDEA Ultimate Edition (version 2024.1.1)
• IntelliJ at /Users/.../Applications/IntelliJ IDEA Ultimate.app
• Flutter plugin version 79.1.3
• Dart plugin version 241.15989.9

[✓] VS Code (version 1.89.0)
• VS Code at /Applications/Visual Studio Code.app/Contents
• Flutter extension version 3.88.0

[✓] Connected device (2 available)
• macOS (desktop) • macos • darwin-arm64 • macOS 14.4.1 23E224 darwin-arm64
• Chrome (web) • chrome • web-javascript • Google Chrome 125.0.6422.60
! Error: Browsing on the local area network for iPad. Ensure the device is unlocked and attached with a cable or associated with the same local area network as this Mac.
The device must be opted into Developer Mode to connect wirelessly. (code -27)

[✓] Network resources
• All expected network resources are available.

[adamsocrat]

@jwren

[jwren]

@alexander-doroshko Given the screenshots and Flutter signatures which can be so long, any objection to changing the signature from being printed so early in DartDocUtil.generateDoc(..)?

[alexander-doroshko]

@adamsocrat The popup seems to be the same in 2023.3.6 and 2024.1. I only see different popup width on the screenshots.

I agree that the information presentation could be improved. How exactly is a matter for discussion. Looking at how it's done for other languages is a good idea.

@jwren Could you clarify your suggestion? Do you mean not to include parameter info in the quick doc popup at all?

[jwren]

@alexander-doroshko The suggestion is to push the signature underneather the other documentation since the Flutter signatures are so long. I started to put together a PR (and am happy to do so still), but stopped as the tests will be a noisy change to change in this manner.

[alexander-doroshko]

@jwren Thanks for the clarification. If it's consistent with other languages that proved to look nicely, I think that would be a good change.