search

carymrobbins / intellij-haskforce

Haskell plugin for IntelliJ IDEA
http://carymrobbins.github.io/intellij-haskforce/
Apache License 2.0
486 stars 39 forks source link

Quick-documentation missing haddock comments #189

Open laura-dietz opened 9 years ago

laura-dietz commented 9 years ago

Currently, Quick documentation (Ctrl-Q) only shows the type signature, but not any Haddock documentation. Especially for source in the current project, for which no recent Haddock documentation is yet compiled if would be tremendously helpful to display such Haddock comments (even unrendered, i.e. without hyperlinks to other symbols)

Idea's PSI should maintain a list of documentation (at least for "before" Haddock comments "-- |") 1

carymrobbins commented 9 years ago

I feel like #185 and #187 are heavily related. These might even be able to be merged into one issue.

laura-dietz commented 9 years ago

I just want to clarify: #187 is respect to documentation that is compiled by Haddock and already sitting around as HTML.

With this issue ( #189 ) I was referring to documentation in the current code project, possibly even in source the user is writing "right now". This code might not even have been compiled, it might even contain syntax errors.

I agree that it is related to #185, in the sense that if the Haskell parser takes care that the documentation finds its way into the PSI, it might even be fixed.