Skip to content

Commit ad14dbb

Browse files
TaritsynTaritsyn
committed
Reformatted a XML documentation comments
1 parent e2972fd commit ad14dbb

File tree

64 files changed

+291
-407
lines changed

Some content is hidden

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

64 files changed

+291
-407
lines changed

‎src/JavaScriptEngineSwitcher.ChakraCore/ChakraCoreJsEngine.cs‎

Lines changed: 1 addition & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ private static void RemoveReferenceToValue(JsValue value)
263263
/// Checks whether the value can have references
264264
/// </summary>
265265
/// <param name="value">The value</param>
266-
/// <returns>Result of check (true - may have; false - may not have)</returns>
266+
/// <returns>Result of check (<c>true</c> - may have; <c>false</c> - may not have)</returns>
267267
private static bool CanHaveReferences(JsValue value)
268268
{
269269
JsValueType valueType = value.ValueType;
@@ -1048,41 +1048,26 @@ protected override void InnerCollectGarbage()
10481048

10491049
#region IJsEngine implementation
10501050

1051-
/// <summary>
1052-
/// Gets a name of JS engine
1053-
/// </summary>
10541051
public override string Name
10551052
{
10561053
get { return EngineName; }
10571054
}
10581055

1059-
/// <summary>
1060-
/// Gets a version of original JS engine
1061-
/// </summary>
10621056
public override string Version
10631057
{
10641058
get { return EngineVersion; }
10651059
}
10661060

1067-
/// <summary>
1068-
/// Gets a value that indicates if the JS engine supports script pre-compilation
1069-
/// </summary>
10701061
public override bool SupportsScriptPrecompilation
10711062
{
10721063
get { return true; }
10731064
}
10741065

1075-
/// <summary>
1076-
/// Gets a value that indicates if the JS engine supports script interruption
1077-
/// </summary>
10781066
public override bool SupportsScriptInterruption
10791067
{
10801068
get { return true; }
10811069
}
10821070

1083-
/// <summary>
1084-
/// Gets a value that indicates if the JS engine supports garbage collection
1085-
/// </summary>
10861071
public override bool SupportsGarbageCollection
10871072
{
10881073
get { return true; }

‎src/JavaScriptEngineSwitcher.ChakraCore/ChakraCoreJsEngineFactory.cs‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@ public ChakraCoreJsEngineFactory(ChakraCoreSettings settings)
3232

3333
#region IJsEngineFactory implementation
3434

35-
/// <summary>
36-
/// Gets a name of JS engine
37-
/// </summary>
35+
/// <inheritdoc/>
3836
public string EngineName
3937
{
4038
get { return ChakraCoreJsEngine.EngineName; }

‎src/JavaScriptEngineSwitcher.ChakraCore/ChakraCorePrecompiledScript.cs‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -113,7 +113,7 @@ public ChakraCorePrecompiledScript(string code, JsParseScriptAttributes parseAtt
113113
/// by debuggable script contexts</param>
114114
/// <param name="value">The script returned</param>
115115
/// <param name="parseAttributes">Attribute mask for parsing the script</param>
116-
/// <returns>true if the operation succeeded, false otherwise</returns>
116+
/// <returns><c>true</c> if the operation succeeded, <c>false</c> otherwise</returns>
117117
private bool LoadScriptSourceCode(JsSourceContext sourceContext, out JsValue value,
118118
out JsParseScriptAttributes parseAttributes)
119119
{
@@ -149,9 +149,7 @@ private bool LoadScriptSourceCode(JsSourceContext sourceContext, out JsValue val
149149

150150
#region IPrecompiledScript implementation
151151

152-
/// <summary>
153-
/// Gets a name of JS engine for which the pre-compiled script was created
154-
/// </summary>
152+
/// <inheritdoc/>
155153
public string EngineName
156154
{
157155
get { return ChakraCoreJsEngine.EngineName; }

‎src/JavaScriptEngineSwitcher.ChakraCore/ChakraCoreSettings.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public bool DisableBackgroundWork
3939
}
4040

4141
/// <summary>
42-
/// Gets or sets a flag for whether to disable calls of <code>eval</code> function
42+
/// Gets or sets a flag for whether to disable calls of <c>eval</c> function
4343
/// </summary>
4444
public bool DisableEval
4545
{
@@ -67,7 +67,7 @@ public bool DisableExecutablePageAllocation
6767
}
6868

6969
/// <summary>
70-
/// Gets or sets a flag for whether to disable Failfast fatal error on OOM
70+
/// Gets or sets a flag for whether to disable <c>Failfast</c> fatal error on OOM
7171
/// </summary>
7272
public bool DisableFatalOnOOM
7373
{
@@ -98,9 +98,8 @@ public bool EnableExperimentalFeatures
9898
/// Gets or sets a maximum stack size in bytes
9999
/// </summary>
100100
/// <remarks>
101-
/// <para>Set a <code>0</code> to use the default maximum stack size specified in the header
101+
/// Set a <c>0</c> to use the default maximum stack size specified in the header
102102
/// for the executable.
103-
/// </para>
104103
/// </remarks>
105104
public int MaxStackSize
106105
{

‎src/JavaScriptEngineSwitcher.ChakraCore/Helpers/NumericHelpers.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ internal static class NumericHelpers
1616
/// Gets a value indicating whether the specified type is one of the numeric types
1717
/// </summary>
1818
/// <param name="type">The type</param>
19-
/// <returns>true if the specified type is one of the numeric types; otherwise, false</returns>
19+
/// <returns><c>true</c> if the specified type is one of the numeric types; otherwise, <c>false</c></returns>
2020
public static bool IsNumericType(Type type)
2121
{
2222
TypeCode typeCode = type.GetTypeCode();

‎src/JavaScriptEngineSwitcher.ChakraCore/Helpers/ReflectionHelpers.cs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ public Type[] ParameterTypes
235235
set;
236236
}
237237

238-
/// TODO: In future will need to change type to <code>double</code>
238+
/// TODO: In future will need to change type to <c>double</c>
239239
public ushort CompatibilityScore
240240
{
241241
get;

‎src/JavaScriptEngineSwitcher.ChakraCore/JsEngineFactoryCollectionExtensions.cs‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -11,10 +11,10 @@ public static class JsEngineFactoryCollectionExtensions
1111
{
1212
/// <summary>
1313
/// Adds a instance of <see cref="ChakraCoreJsEngineFactory"/> to
14-
/// the specified <see cref="JsEngineFactoryCollection" />
14+
/// the specified <see cref="JsEngineFactoryCollection"/>
1515
/// </summary>
16-
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection" /></param>
17-
/// <returns>Instance of <see cref="JsEngineFactoryCollection" /></returns>
16+
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection"/></param>
17+
/// <returns>Instance of <see cref="JsEngineFactoryCollection"/></returns>
1818
public static JsEngineFactoryCollection AddChakraCore(this JsEngineFactoryCollection source)
1919
{
2020
if (source == null)
@@ -27,11 +27,11 @@ public static JsEngineFactoryCollection AddChakraCore(this JsEngineFactoryCollec
2727

2828
/// <summary>
2929
/// Adds a instance of <see cref="ChakraCoreJsEngineFactory"/> to
30-
/// the specified <see cref="JsEngineFactoryCollection" />
30+
/// the specified <see cref="JsEngineFactoryCollection"/>
3131
/// </summary>
32-
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection" /></param>
32+
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection"/></param>
3333
/// <param name="configure">The delegate to configure the provided <see cref="ChakraCoreSettings"/></param>
34-
/// <returns>Instance of <see cref="JsEngineFactoryCollection" /></returns>
34+
/// <returns>Instance of <see cref="JsEngineFactoryCollection"/></returns>
3535
public static JsEngineFactoryCollection AddChakraCore(this JsEngineFactoryCollection source,
3636
Action<ChakraCoreSettings> configure)
3737
{
@@ -53,11 +53,11 @@ public static JsEngineFactoryCollection AddChakraCore(this JsEngineFactoryCollec
5353

5454
/// <summary>
5555
/// Adds a instance of <see cref="ChakraCoreJsEngineFactory"/> to
56-
/// the specified <see cref="JsEngineFactoryCollection" />
56+
/// the specified <see cref="JsEngineFactoryCollection"/>
5757
/// </summary>
58-
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection" /></param>
58+
/// <param name="source">Instance of <see cref="JsEngineFactoryCollection"/></param>
5959
/// <param name="settings">Settings of the ChakraCore JS engine</param>
60-
/// <returns>Instance of <see cref="JsEngineFactoryCollection" /></returns>
60+
/// <returns>Instance of <see cref="JsEngineFactoryCollection"/></returns>
6161
public static JsEngineFactoryCollection AddChakraCore(this JsEngineFactoryCollection source, ChakraCoreSettings settings)
6262
{
6363
if (source == null)

‎src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsContext.cs‎

Lines changed: 16 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -183,9 +183,13 @@ public static JsValue ParseScript(string script, JsSourceContext sourceContext,
183183
/// Parses a serialized script and returns a function representing the script
184184
/// </summary>
185185
/// <remarks>
186-
/// <para>Requires an active script context.</para>
187-
/// <para>The runtime will hold on to the buffer until all instances of any functions created from
188-
/// the buffer are garbage collected.</para>
186+
/// <para>
187+
/// Requires an active script context.
188+
/// </para>
189+
/// <para>
190+
/// The runtime will hold on to the buffer until all instances of any functions created from
191+
/// the buffer are garbage collected.
192+
/// </para>
189193
/// </remarks>
190194
/// <param name="script">The script to parse</param>
191195
/// <param name="buffer">The serialized script</param>
@@ -262,9 +266,13 @@ public static JsValue RunScript(string script, JsSourceContext sourceContext, st
262266
/// Runs a serialized script
263267
/// </summary>
264268
/// <remarks>
265-
/// <para>Requires an active script context.</para>
266-
/// <para>The runtime will detach the data from the buffer and hold on to it until all
267-
/// instances of any functions created from the buffer are garbage collected.</para>
269+
/// <para>
270+
/// Requires an active script context.
271+
/// </para>
272+
/// <para>
273+
/// The runtime will detach the data from the buffer and hold on to it until all
274+
/// instances of any functions created from the buffer are garbage collected.
275+
/// </para>
268276
/// </remarks>
269277
/// <param name="script">The source code of the serialized script</param>
270278
/// <param name="buffer">The serialized script</param>
@@ -436,7 +444,7 @@ public static void SetPromiseContinuationCallback(JsPromiseContinuationCallback
436444
/// Adds a reference to a script context
437445
/// </summary>
438446
/// <remarks>
439-
/// Calling AddRef ensures that the context will not be freed until Release is called.
447+
/// Calling <c>AddRef</c> ensures that the context will not be freed until <c>Release</c> is called.
440448
/// </remarks>
441449
/// <returns>The object's new reference count</returns>
442450
public uint AddRef()
@@ -451,7 +459,7 @@ public uint AddRef()
451459
/// Releases a reference to a script context
452460
/// </summary>
453461
/// <remarks>
454-
/// Removes a reference to a context that was created by AddRef.
462+
/// Removes a reference to a context that was created by <c>AddRef</c>.
455463
/// </remarks>
456464
/// <returns>The object's new reference count</returns>
457465
public uint Release()

‎src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsErrorCode.cs‎

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ public enum JsErrorCode : uint
2323
InvalidArgument,
2424

2525
/// <summary>
26-
/// An argument to a hosting API was null in a context where null is not allowed
26+
/// An argument to a hosting API was <c>null</c> in a context where <c>null</c> is not allowed
2727
/// </summary>
2828
NullArgument,
2929

@@ -125,19 +125,21 @@ public enum JsErrorCode : uint
125125
InObjectBeforeCollectCallback,
126126

127127
/// <summary>
128-
/// Object cannot be unwrapped to IInspectable pointer
128+
/// Object cannot be unwrapped to <c>IInspectable</c> pointer
129129
/// </summary>
130130
ObjectNotInspectable,
131131

132132
/// <summary>
133133
/// A hosting API that operates on symbol property ids but was called with a non-symbol property id.
134-
/// The error code is returned by JsGetSymbolFromPropertyId if the function is called with non-symbol property id.
134+
/// The error code is returned by <c>JsGetSymbolFromPropertyId</c> if the function is called with non-symbol
135+
/// property id.
135136
/// </summary>
136137
PropertyNotSymbol,
137138

138139
/// <summary>
139140
/// A hosting API that operates on string property ids but was called with a non-string property id.
140-
/// The error code is returned by existing JsGetPropertyNamefromId if the function is called with non-string property id.
141+
/// The error code is returned by existing <c>JsGetPropertyNamefromId</c> if the function is called with
142+
/// non-string property id.
141143
/// </summary>
142144
PropertyNotString,
143145

@@ -147,17 +149,17 @@ public enum JsErrorCode : uint
147149
InvalidContext,
148150

149151
/// <summary>
150-
/// The Module HostInfoKind provided was invalid
152+
/// The Module <c>HostInfoKind</c> provided was invalid
151153
/// </summary>
152154
InvalidModuleHostInfoKind,
153155

154156
/// <summary>
155-
/// Module was parsed already when JsParseModuleSource is called
157+
/// Module was parsed already when <c>JsParseModuleSource</c> is called
156158
/// </summary>
157159
ModuleParsed,
158160

159161
/// <summary>
160-
/// Argument passed to JsCreateWeakReference is a primitive that is not managed by the GC.
162+
/// Argument passed to <c>JsCreateWeakReference</c> is a primitive that is not managed by the GC.
161163
/// No weak reference is required, the value will never be collected.
162164
/// </summary>
163165
NoWeakRefRequired,
@@ -216,7 +218,7 @@ public enum JsErrorCode : uint
216218
ScriptTerminated,
217219

218220
/// <summary>
219-
/// A script was terminated because it tried to use <c>eval</c> or <c>function</c> and eval
221+
/// A script was terminated because it tried to use <c>eval</c> or <c>Function</c> and <c>eval</c>
220222
/// was disabled
221223
/// </summary>
222224
ScriptEvalDisabled,

‎src/JavaScriptEngineSwitcher.ChakraCore/JsRt/JsErrorHelpers.cs‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -163,7 +163,7 @@ public static void ThrowIfError(JsErrorCode errorCode)
163163
}
164164

165165
/// <summary>
166-
/// Creates a new JavaScript error object
166+
/// Creates a new JavaScript <c>Error</c> object
167167
/// </summary>
168168
/// <remarks>
169169
/// Requires an active script context.
@@ -179,7 +179,7 @@ public static JsValue CreateError(string message)
179179
}
180180

181181
/// <summary>
182-
/// Creates a new JavaScript RangeError error object
182+
/// Creates a new JavaScript <c>RangeError</c> error object
183183
/// </summary>
184184
/// <remarks>
185185
/// Requires an active script context.
@@ -195,7 +195,7 @@ public static JsValue CreateRangeError(string message)
195195
}
196196

197197
/// <summary>
198-
/// Creates a new JavaScript ReferenceError error object
198+
/// Creates a new JavaScript <c>ReferenceError</c> error object
199199
/// </summary>
200200
/// <remarks>
201201
/// Requires an active script context.
@@ -211,7 +211,7 @@ public static JsValue CreateReferenceError(string message)
211211
}
212212

213213
/// <summary>
214-
/// Creates a new JavaScript SyntaxError error object
214+
/// Creates a new JavaScript <c>SyntaxError</c> error object
215215
/// </summary>
216216
/// <remarks>
217217
/// Requires an active script context.
@@ -227,7 +227,7 @@ public static JsValue CreateSyntaxError(string message)
227227
}
228228

229229
/// <summary>
230-
/// Creates a new JavaScript TypeError error object
230+
/// Creates a new JavaScript <c>TypeError</c> error object
231231
/// </summary>
232232
/// <remarks>
233233
/// Requires an active script context.
@@ -243,7 +243,7 @@ public static JsValue CreateTypeError(string message)
243243
}
244244

245245
/// <summary>
246-
/// Creates a new JavaScript URIError error object
246+
/// Creates a new JavaScript <c>URIError</c> error object
247247
/// </summary>
248248
/// <remarks>
249249
/// Requires an active script context.

0 commit comments

Comments
 (0)