Add comments

Author: xsebek

plugins/hls-refactor-plugin/src/Development/IDE/Plugin/CodeAction.hs

@@ -633,12 +633,14 @@ suggestDeleteUnusedBinding
           } = Just (reLoc lname, matches)
       extractNameAndMatchesFromFunBind _ = Nothing
 
+      -- | For given name, find the span of related type signature.
       findRelatedSigSpan' :: PositionIndexedString -> String -> LSig GhcPs -> [Range]
       findRelatedSigSpan' indexedContent name = \case
 #if MIN_VERSION_ghc(9,9,0)
         (L (EpAnn sigSpan _ c) sig) ->
           let l = epaLocationRealSrcSpan sigSpan
           in case findRelatedSigSpan1 name sig of
+            -- On GHC 9.10+ this will include Haddock comments.
             Just (_span, True) -> pure . extendForSpaces indexedContent . toRange $ l `withCommentSpan` c
 #else
         (reLoc -> L (RealSrcSpan l _) sig) ->
@@ -2119,10 +2121,11 @@ matchRegExMultipleImports message = do
   return (binding, imps)
 
 #if MIN_VERSION_ghc(9,9,0)
+-- | Expand signature span to include Haddock.
 withCommentSpan :: RealSrcSpan -> EpAnnComments -> RealSrcSpan
 withCommentSpan idL = foldl' combineRealSrcSpans idL . map commsSrc . commsToList
   where
-    -- commsSrc :: GenLocated (EpaLocation' a) e -> RealSrcSpan
+    commsSrc :: GenLocated (EpaLocation' a) e -> RealSrcSpan
     commsSrc (L l _) = epaLocationRealSrcSpan l
     commsToList :: EpAnnComments -> [LEpaComment]
     commsToList = \case