Skip to content

Commit 28233de

Browse files
committed
Fix XML documentation issues
1 parent b20c1de commit 28233de

File tree

4 files changed

+69
-4
lines changed

4 files changed

+69
-4
lines changed

src/PowerShellEditorServices/Language/FindDeclarationVisitor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ public override AstVisitAction VisitFunctionDefinition(FunctionDefinitionAst fun
7171
/// Check if the left hand side of an assignmentStatementAst is a VariableExpressionAst
7272
/// with the same name as that of symbolRef.
7373
/// </summary>
74-
/// <param name="assignmentStatementAst">An AssignmentStatementAst/param>
74+
/// <param name="assignmentStatementAst">An AssignmentStatementAst</param>
7575
/// <returns>A decision to stop searching if the right VariableExpressionAst was found,
7676
/// or a decision to continue if it wasn't found</returns>
7777
public override AstVisitAction VisitAssignmentStatement(AssignmentStatementAst assignmentStatementAst)

src/PowerShellEditorServices/Session/EditorSession.cs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -79,9 +79,8 @@ public class EditorSession
7979
/// Starts the session using the provided IConsoleHost implementation
8080
/// for the ConsoleService.
8181
/// </summary>
82-
/// <param name="enableConsoleRepl">
83-
/// Enables a terminal-based REPL for this session.
84-
/// </param>
82+
/// <param name="powerShellContext"></param>
83+
/// <param name="consoleService"></param>
8584
public void StartSession(
8685
PowerShellContext powerShellContext,
8786
ConsoleService consoleService)
@@ -105,6 +104,8 @@ public void StartSession(
105104
/// Starts a debug-only session using the provided IConsoleHost implementation
106105
/// for the ConsoleService.
107106
/// </summary>
107+
/// <param name="powerShellContext"></param>
108+
/// <param name="consoleService"></param>
108109
/// <param name="editorOperations">
109110
/// An IEditorOperations implementation used to interact with the editor.
110111
/// </param>

src/PowerShellEditorServices/Session/PowerShellContext.cs

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,6 +115,13 @@ public string PromptString
115115

116116
#region Constructors
117117

118+
/// <summary>
119+
///
120+
/// </summary>
121+
/// <param name="hostDetails"></param>
122+
/// <param name="powerShellContext"></param>
123+
/// <param name="enableConsoleRepl"></param>
124+
/// <returns></returns>
118125
public static Runspace CreateRunspace(
119126
HostDetails hostDetails,
120127
PowerShellContext powerShellContext,
@@ -125,6 +132,11 @@ public static Runspace CreateRunspace(
125132
return CreateRunspace(psHost);
126133
}
127134

135+
/// <summary>
136+
///
137+
/// </summary>
138+
/// <param name="psHost"></param>
139+
/// <returns></returns>
128140
public static Runspace CreateRunspace(PSHost psHost)
129141
{
130142
var initialSessionState = InitialSessionState.CreateDefault2();

src/PowerShellEditorServices/Session/SessionPSHost.cs

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,9 @@ internal IConsoleHost ConsoleHost
4242
}
4343
}
4444

45+
/// <summary>
46+
/// Gets the ConsoleServices owned by this host.
47+
/// </summary>
4548
public ConsoleService ConsoleService { get; private set; }
4649

4750
#endregion
@@ -93,60 +96,94 @@ public ConsoleServicePSHost(
9396

9497
#region PSHost Implementation
9598

99+
/// <summary>
100+
///
101+
/// </summary>
96102
public override Guid InstanceId
97103
{
98104
get { return this.instanceId; }
99105
}
100106

107+
/// <summary>
108+
///
109+
/// </summary>
101110
public override string Name
102111
{
103112
get { return this.hostDetails.Name; }
104113
}
105114

115+
/// <summary>
116+
///
117+
/// </summary>
106118
public override Version Version
107119
{
108120
get { return this.hostDetails.Version; }
109121
}
110122

111123
// TODO: Pull these from IConsoleHost
112124

125+
/// <summary>
126+
///
127+
/// </summary>
113128
public override System.Globalization.CultureInfo CurrentCulture
114129
{
115130
get { return System.Globalization.CultureInfo.CurrentCulture; }
116131
}
117132

133+
/// <summary>
134+
///
135+
/// </summary>
118136
public override System.Globalization.CultureInfo CurrentUICulture
119137
{
120138
get { return System.Globalization.CultureInfo.CurrentUICulture; }
121139
}
122140

141+
/// <summary>
142+
///
143+
/// </summary>
123144
public override PSHostUserInterface UI
124145
{
125146
get { return this.hostUserInterface; }
126147
}
127148

149+
/// <summary>
150+
///
151+
/// </summary>
128152
public override void EnterNestedPrompt()
129153
{
130154
Logger.Write(LogLevel.Verbose, "EnterNestedPrompt() called.");
131155
}
132156

157+
/// <summary>
158+
///
159+
/// </summary>
133160
public override void ExitNestedPrompt()
134161
{
135162
Logger.Write(LogLevel.Verbose, "ExitNestedPrompt() called.");
136163
}
137164

165+
/// <summary>
166+
///
167+
/// </summary>
138168
public override void NotifyBeginApplication()
139169
{
140170
Logger.Write(LogLevel.Verbose, "NotifyBeginApplication() called.");
141171
this.isNativeApplicationRunning = true;
142172
}
143173

174+
/// <summary>
175+
///
176+
/// </summary>
144177
public override void NotifyEndApplication()
145178
{
146179
Logger.Write(LogLevel.Verbose, "NotifyEndApplication() called.");
147180
this.isNativeApplicationRunning = false;
148181
}
149182

183+
/// <summary>
184+
///
185+
/// </summary>
186+
/// <param name="exitCode"></param>
150187
public override void SetShouldExit(int exitCode)
151188
{
152189
if (this.consoleHost != null)
@@ -164,6 +201,10 @@ public override void SetShouldExit(int exitCode)
164201

165202
#region IHostSupportsInteractiveSession Implementation
166203

204+
/// <summary>
205+
///
206+
/// </summary>
207+
/// <returns></returns>
167208
public bool IsRunspacePushed
168209
{
169210
get
@@ -179,6 +220,10 @@ public bool IsRunspacePushed
179220
}
180221
}
181222

223+
/// <summary>
224+
///
225+
/// </summary>
226+
/// <returns></returns>
182227
public Runspace Runspace
183228
{
184229
get
@@ -194,6 +239,10 @@ public Runspace Runspace
194239
}
195240
}
196241

242+
/// <summary>
243+
///
244+
/// </summary>
245+
/// <param name="runspace"></param>
197246
public void PushRunspace(Runspace runspace)
198247
{
199248
if (this.hostSupportsInteractiveSession != null)
@@ -206,6 +255,9 @@ public void PushRunspace(Runspace runspace)
206255
}
207256
}
208257

258+
/// <summary>
259+
///
260+
/// </summary>
209261
public void PopRunspace()
210262
{
211263
if (this.hostSupportsInteractiveSession != null)

0 commit comments

Comments
 (0)