Skip to content

Commit 9de1f3a

Browse files
committed
Add missing API documentation
1 parent 2e5bc40 commit 9de1f3a

File tree

3 files changed

+12
-4
lines changed

3 files changed

+12
-4
lines changed

src/PowerShellEditorServices.Host/Program.cs

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ class Program
1616
[STAThread]
1717
static void Main(string[] args)
1818
{
19+
#if DEBUG
1920
// In the future, a more robust argument parser will be added here
2021
bool waitForDebugger =
2122
args.Any(
@@ -36,6 +37,7 @@ static void Main(string[] args)
3637
waitCountdown--;
3738
}
3839
}
40+
#endif
3941

4042
// TODO: Select host, console host, and transport based on command line arguments
4143

src/PowerShellEditorServices/Language/LanguageService.cs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -207,11 +207,13 @@ public FindReferencesResult FindReferencesOfSymbol(
207207
}
208208

209209
/// <summary>
210-
/// Finds the definition of a symbol in the script
210+
/// Finds the definition of a symbol in the script file or any of the
211+
/// files that it references.
211212
/// </summary>
212-
/// <param name="foundSymbol">The symbol to find a definition for</param>
213-
/// <param name="referencedFiles">An array of scriptFiles too search for the definition in</param>
214-
/// <returns>GetDefinitionResult</returns>
213+
/// <param name="sourceFile">The initial script file to be searched for the symbol's definition.</param>
214+
/// <param name="foundSymbol">The symbol for which a definition will be found.</param>
215+
/// <param name="workspace">The Workspace to which the ScriptFile belongs.</param>
216+
/// <returns>The resulting GetDefinitionResult for the symbol's definition.</returns>
215217
public GetDefinitionResult GetDefinitionOfSymbol(
216218
ScriptFile sourceFile,
217219
SymbolReference foundSymbol,

src/PowerShellEditorServices/Session/Workspace.cs

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,10 @@
1111

1212
namespace Microsoft.PowerShell.EditorServices.Session
1313
{
14+
/// <summary>
15+
/// Manages a "workspace" of script files that are open for a particular
16+
/// editing session. Also helps to navigate references between ScriptFiles.
17+
/// </summary>
1418
public class Workspace
1519
{
1620
#region Private Fields

0 commit comments

Comments
 (0)