Skip to content

Commit 6dbc947

Browse files
committed
WIP #51 - Minor docco improvements
1 parent b2b1902 commit 6dbc947

1 file changed

Lines changed: 13 additions & 3 deletions

File tree

CSF.Extensions.WebDriver/Factories/WebDriverCreationOptions.cs

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,9 @@ public class WebDriverCreationOptions
7171
/// the appropriate options type if this property is <see langword="null" />.
7272
/// </para>
7373
/// <para>
74-
/// In a similar manner to <see cref="DriverType"/>, if
74+
/// In a similar manner to <see cref="DriverType"/>, if this property is set to an options type which is shipped with Selenium
75+
/// out-of-the-box then it need only be set to the simple type name. If a custom options type is required, which does not ship
76+
/// with Selenium, then this must be an assembly-qualified type name.
7577
/// </para>
7678
/// </remarks>
7779
/// <seealso cref="DriverType"/>
@@ -147,7 +149,7 @@ public class WebDriverCreationOptions
147149
public object OptionsCustomizer { get; set; }
148150

149151
/// <summary>
150-
/// Unneeded except in unusual circumstances, gets or sets the name of a type which is used to construct the WebDriver instance.
152+
/// Gets or sets the name of a type which is used to construct the WebDriver instance; unneeded except in unusual circumstances.
151153
/// </summary>
152154
/// <remarks>
153155
/// <para>
@@ -162,7 +164,15 @@ public class WebDriverCreationOptions
162164
/// If <see cref="DriverType"/> is set to a third-party WebDriver implementation which does not follow the pattern above,
163165
/// such as one which has a different constructor parameter signature, this library
164166
/// requires some help in instantiating the WebDriver.
165-
/// In that case (only), this property should be set to the assembly-qualified type name of a type which implements
167+
/// </para>
168+
/// <para>
169+
/// Alternatively, you may need to use a custom factory, identified by this configuration property, if you require additional customisation
170+
/// of the WebDriver after creation, which cannot be achieved only with options.
171+
/// For example, if you are making use a custom third-party integration which adds an additional layer of capabilities to
172+
/// communicate the name of a currently-running test. This information can be retrieved only at runtime and not from configuration.
173+
/// </para>
174+
/// <para>
175+
/// In cases like the above, this property should be set to the assembly-qualified type name of a type which implements
166176
/// <see cref="ICreatesWebDriverFromOptions"/>. That type must be provided by the developer using this library. The factory
167177
/// is responsible for constructing the WebDriver instance from options and returning it.
168178
/// </para>

0 commit comments

Comments
 (0)