Skip to content

Commit 9b2043d

Browse files
committed
Improve comments about plugin file types
1 parent 6df3536 commit 9b2043d

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
@@ -288,17 +288,18 @@ data PluginDescriptor (ideState :: Type) =
288288
-- The file extension must have a leading '.'.
289289
}
290290

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

297297
data SourceFileOrigin = FromProject | FromDependency deriving Eq
298298

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

0 commit comments

Comments
 (0)