Skip to content

Commit dc90c29

Browse files
committed
Refactor Client module and improve documentation for analyzer methods
1 parent 253c288 commit dc90c29

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

src/FSharp.Analyzers.SDK/FSharp.Analyzers.SDK.Client.fsi

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,7 @@ type AnalysisResult =
88
Output: Result<Message list, exn>
99
}
1010

11-
module Client =
12-
11+
module Client =
1312
type RegisteredAnalyzer<'TContext when 'TContext :> Context> =
1413
{
1514
AssemblyPath: string
@@ -46,17 +45,23 @@ type Client<'TAttribute, 'TContext when 'TAttribute :> AnalyzerAttribute and 'TC
4645
/// <returns>number of found dlls matching `*Analyzer*.dll` and number of registered analyzers</returns>
4746
member LoadAnalyzers: dir: string * ?excludeInclude: ExcludeInclude -> AssemblyLoadStats
4847
/// <summary>Runs all registered analyzers for given context (file).</summary>
48+
/// <param name="ctx">The context (file) to analyze.</param>
4949
/// <returns>list of messages. Ignores errors from the analyzers</returns>
5050
member RunAnalyzers: ctx: 'TContext -> Async<AnalyzerMessage list>
5151

5252
/// <summary>Runs all registered analyzers for given context (file).</summary>
53+
/// <param name="ctx">The context (file) to analyze.</param>
54+
/// <param name="analyzerPredicate">A predicate function to filter which analyzers to run.</param>
5355
/// <returns>list of messages. Ignores errors from the analyzers</returns>
5456
member RunAnalyzers: ctx: 'TContext * analyzerPredicate: (Client.RegisteredAnalyzer<'TContext> -> bool) -> Async<AnalyzerMessage list>
5557

5658
/// <summary>Runs all registered analyzers for given context (file).</summary>
59+
/// <param name="ctx">The context (file) to analyze.</param>
5760
/// <returns>list of results per analyzer which can either be messages or an exception.</returns>
5861
member RunAnalyzersSafely: ctx: 'TContext -> Async<AnalysisResult list>
5962

6063
/// <summary>Runs all registered analyzers for given context (file).</summary>
64+
/// <param name="ctx">The context (file) to analyze.</param>
65+
/// <param name="analyzerPredicate">A predicate function to filter which analyzers to run.</param>
6166
/// <returns>list of results per analyzer which can either be messages or an exception.</returns>
6267
member RunAnalyzersSafely: ctx: 'TContext * analyzerPredicate: (Client.RegisteredAnalyzer<'TContext> -> bool) -> Async<AnalysisResult list>

0 commit comments

Comments
 (0)