Skip to content

Commit 2ad66f0

Browse files
committed
Reformatted a XML documentation comments
1 parent 3cce29f commit 2ad66f0

File tree

67 files changed

+245
-250
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

67 files changed

+245
-250
lines changed

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptException.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ namespace MsieJavaScriptEngine.ActiveScript
99
public sealed class ActiveScriptException : Exception
1010
{
1111
/// <summary>
12-
/// The HRESULT of the error
12+
/// The <c>HRESULT</c> of the error
1313
/// </summary>
1414
private int _errorCode;
1515

@@ -54,7 +54,7 @@ public sealed class ActiveScriptException : Exception
5454
private string _sourceFragment = string.Empty;
5555

5656
/// <summary>
57-
/// Gets or sets a HRESULT of the error
57+
/// Gets or sets a <c>HRESULT</c> of the error
5858
/// </summary>
5959
public int ErrorCode
6060
{

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptJsEngineBase.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -184,7 +184,7 @@ protected ActiveScriptJsEngineBase(JsEngineSettings settings, string clsid,
184184
/// Initializes a script dispatcher
185185
/// </summary>
186186
/// <param name="maxStackSize">The maximum stack size, in bytes, to be used by the thread,
187-
/// or 0 to use the default maximum stack size specified in the header for the executable.</param>
187+
/// or <c>0</c> to use the default maximum stack size specified in the header for the executable.</param>
188188
private static void InitScriptDispatcher(int maxStackSize)
189189
{
190190
if (_dispatcher != null)
@@ -209,7 +209,7 @@ private static void InitScriptDispatcher(int maxStackSize)
209209
/// <param name="clsid">CLSID of JS engine</param>
210210
/// <param name="isSupported">Flag indicating whether this JS engine is supported</param>
211211
/// <param name="supportSynchronizer">Support synchronizer</param>
212-
/// <returns>Result of check (true - supports; false - does not support)</returns>
212+
/// <returns>Result of check (<c>true</c> - supports; <c>false</c> - does not support)</returns>
213213
protected static bool IsSupported(string clsid, ref bool? isSupported, ref object supportSynchronizer)
214214
{
215215
if (isSupported.HasValue)
@@ -315,7 +315,7 @@ protected virtual void InitScriptContext()
315315
}
316316

317317
/// <summary>
318-
/// Gets and resets a last exception. Returns null for none.
318+
/// Gets and resets a last exception. Returns <c>null</c> for none.
319319
/// </summary>
320320
private ActiveScriptException GetAndResetLastException()
321321
{
@@ -417,7 +417,7 @@ private void InnerExecuteResource(string resourceName, Assembly assembly)
417417
/// <param name="code">Script text</param>
418418
/// <param name="sourceContext">Application specific source context</param>
419419
/// <param name="document">Debug document</param>
420-
/// <returns>Result of creating a debug document (true - is created; false - is not created)</returns>
420+
/// <returns>Result of creating a debug document (<c>true</c> - is created; <c>false</c> - is not created)</returns>
421421
private bool TryCreateDebugDocument(string name, string code, out UIntPtr sourceContext,
422422
out DebugDocument document)
423423
{

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptJsErrorHelpers.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ internal static class ActiveScriptJsErrorHelpers
1616
/// Checks whether the specified error number is compilation error
1717
/// </summary>
1818
/// <param name="errorNumber">Error number</param>
19-
/// <returns>Result of check (true - is compilation error; false - is not compilation error)</returns>
19+
/// <returns>Result of check (<c>true</c> - is compilation error; <c>false</c> - is not compilation error)</returns>
2020
public static bool IsCompilationError(int errorNumber)
2121
{
2222
bool result = errorNumber >= JScriptSyntaxErrorNumber.SyntaxError
@@ -29,7 +29,7 @@ public static bool IsCompilationError(int errorNumber)
2929
/// Checks whether the specified error number is runtime error
3030
/// </summary>
3131
/// <param name="errorNumber">Error number</param>
32-
/// <returns>Result of check (true - is runtime error; false - is not runtime error)</returns>
32+
/// <returns>Result of check (<c>true</c> - is runtime error; <c>false</c> - is not runtime error)</returns>
3333
public static bool IsRuntimeError(int errorNumber)
3434
{ bool result = errorNumber == JScriptRuntimeErrorNumber.OutOfStackSpace
3535
|| (errorNumber >= JScriptRuntimeErrorNumber.CannotAssignToThisKeyword

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptWrapper32.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@ public override void Dispose()
142142
/// <summary>
143143
/// Destroys object
144144
/// </summary>
145-
/// <param name="disposing">Flag, allowing destruction of
146-
/// managed objects contained in fields of class</param>
145+
/// <param name="disposing">Flag, allowing destruction of managed objects contained in fields of class</param>
147146
protected override void Dispose(bool disposing)
148147
{
149148
if (disposing)

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptWrapper64.cs

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -142,8 +142,7 @@ public override void Dispose()
142142
/// <summary>
143143
/// Destroys object
144144
/// </summary>
145-
/// <param name="disposing">Flag, allowing destruction of
146-
/// managed objects contained in fields of class</param>
145+
/// <param name="disposing">Flag, allowing destruction of managed objects contained in fields of class</param>
147146
protected override void Dispose(bool disposing)
148147
{
149148
if (disposing)

src/MsieJavaScriptEngine/ActiveScript/ActiveScriptWrapperBase.cs

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -151,11 +151,11 @@ public object GetScriptDispatch()
151151
/// <param name="code">The scriptlet text to evaluate. The interpretation of this
152152
/// string depends on the scripting language</param>
153153
/// <param name="itemName">The item name that gives the context in which the
154-
/// scriptlet is to be evaluated. If this parameter is null, the code is evaluated
154+
/// scriptlet is to be evaluated. If this parameter is <c>null</c>, the code is evaluated
155155
/// in the scripting engine's global context</param>
156156
/// <param name="context">The context object. This object is reserved for use in a
157157
/// debugging environment, where such a context may be provided by the debugger to
158-
/// represent an active run-time context. If this parameter is null, the engine
158+
/// represent an active run-time context. If this parameter is <c>null</c>, the engine
159159
/// uses <paramref name="itemName"/> to identify the context.</param>
160160
/// <param name="delimiter">The end-of-scriptlet delimiter. When <paramref name="code"/>
161161
/// is parsed from a stream of text, the host typically uses a delimiter, such as two
@@ -164,14 +164,14 @@ public object GetScriptDispatch()
164164
/// some conditional primitive preprocessing (for example, replacing a single quotation
165165
/// mark ['] with two single quotation marks for use as a delimiter). Exactly how
166166
/// (and if) the scripting engine makes use of this information depends on the
167-
/// scripting engine. Set this parameter to null if the host did not use a delimiter
167+
/// scripting engine. Set this parameter to <c>null</c> if the host did not use a delimiter
168168
/// to mark the end of the scriptlet.</param>
169169
/// <param name="sourceContextCookie">Application-defined value that is used for
170170
/// debugging purposes</param>
171171
/// <param name="startingLineNumber">Zero-based value that specifies which line the
172172
/// parsing will begin at</param>
173173
/// <param name="flags">Flags associated with the scriptlet</param>
174-
/// <returns>The results of scriptlet processing, or null if the caller expects no
174+
/// <returns>The results of scriptlet processing, or <c>null</c> if the caller expects no
175175
/// result (that is, the <see cref="ScriptTextFlags.IsExpression"/> value is not set)</returns>
176176
public abstract object ParseScriptText(string code, string itemName, object context, string delimiter,
177177
UIntPtr sourceContextCookie, uint startingLineNumber, ScriptTextFlags flags);
@@ -240,8 +240,7 @@ public void CollectGarbage(ScriptGCType type)
240240
/// <summary>
241241
/// Destroys object
242242
/// </summary>
243-
/// <param name="disposing">Flag, allowing destruction of
244-
/// managed objects contained in fields of class</param>
243+
/// <param name="disposing">Flag, allowing destruction of managed objects contained in fields of class</param>
245244
protected virtual void Dispose(bool disposing)
246245
{
247246
if (disposing)

src/MsieJavaScriptEngine/ActiveScript/ChakraActiveScriptJsEngine.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public ChakraActiveScriptJsEngine(JsEngineSettings settings)
7272
/// <summary>
7373
/// Checks a support of the Chakra Active Script engine on the machine
7474
/// </summary>
75-
/// <returns>Result of check (true - supports; false - does not support)</returns>
75+
/// <returns>Result of check (<c>true</c> - supports; <c>false</c> - does not support)</returns>
7676
public static bool IsSupported()
7777
{
7878
bool isSupported = IsSupported(ClassId.Chakra, ref _isSupported, ref _supportSynchronizer);

src/MsieJavaScriptEngine/ActiveScript/ClassicActiveScriptJsEngine.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@ public ClassicActiveScriptJsEngine(JsEngineSettings settings)
7474
/// <summary>
7575
/// Checks a support of the Classic Active Script engine on the machine
7676
/// </summary>
77-
/// <returns>Result of check (true - supports; false - does not support)</returns>
77+
/// <returns>Result of check (<c>true</c> - supports; <c>false</c> - does not support)</returns>
7878
public static bool IsSupported()
7979
{
8080
bool isSupported = IsSupported(ClassId.Classic, ref _isSupported, ref _supportSynchronizer);

src/MsieJavaScriptEngine/ActiveScript/Debugging/DebugApplicationWrapper.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,7 +112,7 @@ public void CreateApplicationNode(out IDebugApplicationNode node)
112112
/// Returns the current debugger connected to the application
113113
/// </summary>
114114
/// <param name="debugger">The current debugger connected to the application</param>
115-
/// <returns>The method returns an HRESULT</returns>
115+
/// <returns>The method returns an <c>HRESULT</c></returns>
116116
public uint GetDebugger(out IApplicationDebugger debugger)
117117
{
118118
uint result = _is64Bit ?

src/MsieJavaScriptEngine/ActiveScript/Debugging/DebugStackFrameDescriptor.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ internal struct DebugStackFrameDescriptor
3838
public bool IsFinal;
3939

4040
/// <summary>
41-
/// If this parameter is not null, the current enumerator merging should stop and
41+
/// If this parameter is not <c>null</c>, the current enumerator merging should stop and
4242
/// a new one should be started. The object indicates how to start the new enumeration.
4343
/// </summary>
4444
public IntPtr pFinalObject;

0 commit comments

Comments
 (0)