Skip to content

Commit efb2c6c

Browse files
TaritsynTaritsyn
committed
Reformatted a XML documentation comments again
1 parent cb35c8d commit efb2c6c

15 files changed

+67
-35
lines changed

‎src/MsieJavaScriptEngine/ActiveScript/Debugging/DebugStackFrameDescriptor.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,11 @@ namespace MsieJavaScriptEngine.ActiveScript.Debugging
77
/// <summary>
88
/// Enumerates stack frames and merges output from several enumerators on the same thread
99
/// </summary>
10-
/// <remarks>The process debug manager uses this structure to sort the stack frames from
10+
/// <remarks>
11+
/// The process debug manager uses this structure to sort the stack frames from
1112
/// multiple script engines. By convention, stacks grow down. Consequently, on architectures
12-
/// where stacks grow up, the addresses should be twos-complemented.</remarks>
13+
/// where stacks grow up, the addresses should be twos-complemented.
14+
/// </remarks>
1315
[StructLayout(LayoutKind.Sequential)]
1416
internal struct DebugStackFrameDescriptor
1517
{

‎src/MsieJavaScriptEngine/IInnerJsEngine.cs

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ internal interface IInnerJsEngine : IDisposable
5757
object CallFunction(string functionName, params object[] args);
5858

5959
/// <summary>
60-
/// Сhecks for the existence of a variable
60+
/// Checks for the existence of a variable
6161
/// </summary>
6262
/// <param name="variableName">Name of variable</param>
6363
/// <returns>Result of check (<c>true</c> - exists; <c>false</c> - not exists</returns>
@@ -86,20 +86,22 @@ internal interface IInnerJsEngine : IDisposable
8686
/// <summary>
8787
/// Embeds a host object to script code
8888
/// </summary>
89+
/// <remarks>
90+
/// Allows to embed instances of simple classes (or structures) and delegates.
91+
/// </remarks>
8992
/// <param name="itemName">The name for the new global variable or function that will represent the object</param>
9093
/// <param name="value">The object to expose</param>
91-
/// <remarks>Allows to embed instances of simple classes (or structures) and delegates.</remarks>
9294
void EmbedHostObject(string itemName, object value);
9395

9496
/// <summary>
9597
/// Embeds a host type to script code
9698
/// </summary>
97-
/// <param name="itemName">The name for the new global variable that will represent the type</param>
98-
/// <param name="type">The type to expose</param>
9999
/// <remarks>
100100
/// Host types are exposed to script code in the form of objects whose properties and
101101
/// methods are bound to the type's static members.
102102
/// </remarks>
103+
/// <param name="itemName">The name for the new global variable that will represent the type</param>
104+
/// <param name="type">The type to expose</param>
103105
void EmbedHostType(string itemName, Type type);
104106

105107
/// <summary>

‎src/MsieJavaScriptEngine/InnerJsEngineBase.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,38 +39,53 @@ protected InnerJsEngineBase(JsEngineSettings settings)
3939

4040
#region IInnerJsEngine implementation
4141

42+
/// <inheritdoc/>
4243
public string Mode
4344
{
4445
get { return _engineModeName; }
4546
}
4647

48+
/// <inheritdoc/>
4749
public abstract bool SupportsScriptPrecompilation { get; }
4850

4951

52+
/// <inheritdoc/>
5053
public abstract PrecompiledScript Precompile(string code, string documentName);
5154

55+
/// <inheritdoc/>
5256
public abstract object Evaluate(string expression, string documentName);
5357

58+
/// <inheritdoc/>
5459
public abstract void Execute(string code, string documentName);
5560

61+
/// <inheritdoc/>
5662
public abstract void Execute(PrecompiledScript precompiledScript);
5763

64+
/// <inheritdoc/>
5865
public abstract object CallFunction(string functionName, params object[] args);
5966

67+
/// <inheritdoc/>
6068
public abstract bool HasVariable(string variableName);
6169

70+
/// <inheritdoc/>
6271
public abstract object GetVariableValue(string variableName);
6372

73+
/// <inheritdoc/>
6474
public abstract void SetVariableValue(string variableName, object value);
6575

76+
/// <inheritdoc/>
6677
public abstract void RemoveVariable(string variableName);
6778

79+
/// <inheritdoc/>
6880
public abstract void EmbedHostObject(string itemName, object value);
6981

82+
/// <inheritdoc/>
7083
public abstract void EmbedHostType(string itemName, Type type);
7184

85+
/// <inheritdoc/>
7286
public abstract void Interrupt();
7387

88+
/// <inheritdoc/>
7489
public abstract void CollectGarbage();
7590

7691
#endregion

‎src/MsieJavaScriptEngine/JsEngineSettings.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,9 +50,8 @@ public JsEngineMode EngineMode
5050
/// Gets or sets a maximum stack size in bytes
5151
/// </summary>
5252
/// <remarks>
53-
/// <para>Set a <c>0</c> to use the default maximum stack size specified in the header
53+
/// Set a <c>0</c> to use the default maximum stack size specified in the header
5454
/// for the executable.
55-
/// </para>
5655
/// </remarks>
5756
public int MaxStackSize
5857
{

‎src/MsieJavaScriptEngine/JsRt/Edge/EdgeJsContext.cs

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,9 +164,13 @@ public static EdgeJsValue ParseScript(string script, JsSourceContext sourceConte
164164
/// Parses a serialized script and returns a function representing the script
165165
/// </summary>
166166
/// <remarks>
167-
/// <para>Requires an active script context.</para>
168-
/// <para>The runtime will hold on to the buffer until all instances of any functions created from
169-
/// the buffer are garbage collected.</para>
167+
/// <para>
168+
/// Requires an active script context.
169+
/// </para>
170+
/// <para>
171+
/// The runtime will hold on to the buffer until all instances of any functions created from
172+
/// the buffer are garbage collected.
173+
/// </para>
170174
/// </remarks>
171175
/// <param name="script">The script to parse</param>
172176
/// <param name="buffer">The serialized script</param>
@@ -208,9 +212,13 @@ public static EdgeJsValue RunScript(string script, JsSourceContext sourceContext
208212
/// Runs a serialized script
209213
/// </summary>
210214
/// <remarks>
211-
/// <para>Requires an active script context.</para>
212-
/// <para>The runtime will hold on to the buffer until all instances of any functions created from
213-
/// the buffer are garbage collected.</para>
215+
/// <para>
216+
/// Requires an active script context.
217+
/// </para>
218+
/// <para>
219+
/// The runtime will hold on to the buffer until all instances of any functions created from
220+
/// the buffer are garbage collected.
221+
/// </para>
214222
/// </remarks>
215223
/// <param name="script">The source code of the serialized script</param>
216224
/// <param name="buffer">The serialized script</param>

‎src/MsieJavaScriptEngine/JsRt/Edge/EdgeJsPropertyId.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ public static EdgeJsPropertyId Invalid
2929
/// Gets a name associated with the property ID
3030
/// </summary>
3131
/// <remarks>
32-
/// <para>
3332
/// Requires an active script context.
34-
/// </para>
3533
/// </remarks>
3634
public string Name
3735
{

‎src/MsieJavaScriptEngine/JsRt/Edge/EdgeJsRuntime.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ namespace MsieJavaScriptEngine.JsRt.Edge
1515
/// time.
1616
/// </para>
1717
/// <para>
18-
/// NOTE: A <see cref="EdgeJsRuntime" />, unlike other objects in the Chakra hosting API, is not
18+
/// NOTE: A <see cref="EdgeJsRuntime"/>, unlike other objects in the Chakra hosting API, is not
1919
/// garbage collected since it contains the garbage collected heap itself. A runtime will
2020
/// continue to exist until <c>Dispose</c> is called.
2121
/// </para>

‎src/MsieJavaScriptEngine/JsRt/Ie/IeJsContext.cs

Lines changed: 14 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -167,9 +167,13 @@ public static IeJsValue ParseScript(string script, JsSourceContext sourceContext
167167
/// Parses a serialized script and returns a function representing the script
168168
/// </summary>
169169
/// <remarks>
170-
/// <para>Requires an active script context.</para>
171-
/// <para>The runtime will hold on to the buffer until all instances of any functions created from
172-
/// the buffer are garbage collected.</para>
170+
/// <para>
171+
/// Requires an active script context.
172+
/// </para>
173+
/// <para>
174+
/// The runtime will hold on to the buffer until all instances of any functions created from
175+
/// the buffer are garbage collected.
176+
/// </para>
173177
/// </remarks>
174178
/// <param name="script">The script to parse</param>
175179
/// <param name="buffer">The serialized script</param>
@@ -211,9 +215,13 @@ public static IeJsValue RunScript(string script, JsSourceContext sourceContext,
211215
/// Runs a serialized script
212216
/// </summary>
213217
/// <remarks>
214-
/// <para>Requires an active script context.</para>
215-
/// <para>The runtime will hold on to the buffer until all instances of any functions created from
216-
/// the buffer are garbage collected.</para>
218+
/// <para>
219+
/// Requires an active script context.
220+
/// </para>
221+
/// <para>
222+
/// The runtime will hold on to the buffer until all instances of any functions created from
223+
/// the buffer are garbage collected.
224+
/// </para>
217225
/// </remarks>
218226
/// <param name="script">The source code of the serialized script</param>
219227
/// <param name="buffer">The serialized script</param>

‎src/MsieJavaScriptEngine/JsRt/Ie/IeJsPropertyId.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,9 +29,7 @@ public static IeJsPropertyId Invalid
2929
/// Gets a name associated with the property ID
3030
/// </summary>
3131
/// <remarks>
32-
/// <para>
3332
/// Requires an active script context.
34-
/// </para>
3533
/// </remarks>
3634
public string Name
3735
{

‎src/MsieJavaScriptEngine/JsRt/Ie/IeJsRuntime.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ namespace MsieJavaScriptEngine.JsRt.Ie
1818
/// time.
1919
/// </para>
2020
/// <para>
21-
/// NOTE: A <see cref="IeJsRuntime" />, unlike other objects in the Chakra hosting API, is not
21+
/// NOTE: A <see cref="IeJsRuntime"/>, unlike other objects in the Chakra hosting API, is not
2222
/// garbage collected since it contains the garbage collected heap itself. A runtime will
2323
/// continue to exist until <c>Dispose</c> is called.
2424
/// </para>

0 commit comments

Comments
 (0)