Skip to content

Commit 26688ce

Browse files
committed
Improve comments about plugin file types
1 parent b7831d5 commit 26688ce

File tree

1 file changed

+8
-7
lines changed

1 file changed

+8
-7
lines changed

hls-plugin-api/src/Ide/Types.hs

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -286,17 +286,18 @@ data PluginDescriptor (ideState :: Type) =
286286
-- The file extension must have a leading '.'.
287287
}
288288

289-
-- A description of the types of files that the plugin
290-
-- is intended to work on. It includes the origin of the
291-
-- file (the project, a dependency, or both), and the
292-
-- file extensions the plugin should work on.
289+
-- | A description of the types of files that the plugin
290+
-- is intended to work on. It includes the origin of the
291+
-- file (the project, a dependency, or both), and the
292+
-- file extensions the plugin should work on.
293293
data PluginFileType = PluginFileType [SourceFileOrigin] [T.Text]
294294

295295
data SourceFileOrigin = FromProject | FromDependency deriving Eq
296296

297-
-- Dependency files are written to the .hls/dependencies directory.
298-
-- If a file is not in this directory, we assume that it is a
299-
-- project file.
297+
-- | Dependency files are written to the .hls/dependencies directory
298+
-- under the project root.
299+
-- If a file is not in this directory, we assume that it is a
300+
-- project file.
300301
getSourceFileOrigin :: NormalizedFilePath -> SourceFileOrigin
301302
getSourceFileOrigin f =
302303
case [".hls", "dependencies"] `isInfixOf` (splitDirectories file) of

0 commit comments

Comments
 (0)