Class Inherit

Class to help generate documentation with DocFX with inheritdoc tags. Not to be used in actual code!

Inheritance

object

Inherit

Namespace: Responsible.Docs

Assembly: Responsible.dll

Syntax

public abstract class Inherit

Remarks

Can't be excluded from DocFX or be internal without breaking functionality :/ DocFX seems to require the argument count to match, thus this is a bit repetitive.

Methods

BddKeyword(string, ITestInstruction<object>)

Declaration

public abstract IBddStep BddKeyword(string description, ITestInstruction<object> instruction)

Parameters

Type	Name	Description
string	description	Description of the step.
ITestInstruction<object>	instruction	Instruction to execute in this step.

Returns

Type	Description
IBddStep	The given instruction as a BDD test step.

CallerMemberWithDescriptionAndContext<T>(string, T, Action<StateStringBuilder>, string, string, int)

Declaration

public void CallerMemberWithDescriptionAndContext<T>(string description, T arg, Action<StateStringBuilder> extraContext = null, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
string	description	Description of the operation, to be included in the state output.
T	arg
Action<StateStringBuilder>	extraContext	Action for producing extra context into state descriptions.
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T

CallerMemberWithDescriptionAndContext<T1, T2>(string, T1, T2, Action<StateStringBuilder>, string, string, int)

Declaration

public void CallerMemberWithDescriptionAndContext<T1, T2>(string description, T1 arg1, T2 arg2, Action<StateStringBuilder> extraContext = null, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
string	description	Description of the operation, to be included in the state output.
T1	arg1
T2	arg2
Action<StateStringBuilder>	extraContext	Action for producing extra context into state descriptions.
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T1
T2

CallerMemberWithDescription<T>(string, T, string, string, int)

Declaration

public void CallerMemberWithDescription<T>(string description, T arg, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
string	description	Description of the operation, to be included in the state output.
T	arg
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T

CallerMemberWithExecutor<T>(T, TestInstructionExecutor, CancellationToken, string, string, int)

Declaration

public void CallerMemberWithExecutor<T>(T arg1, TestInstructionExecutor executor, CancellationToken cancellationToken = default, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T	arg1
TestInstructionExecutor	executor	Test test instruction executor to use.
CancellationToken	cancellationToken	Optional cancellation token to cancel the instruction prematurely.
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T

CallerMember<T>(T, string, string, int)

Declaration

public void CallerMember<T>(T arg1, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T	arg1
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T

CallerMember<T1, T2>(T1, T2, string, string, int)

Declaration

public void CallerMember<T1, T2>(T1 arg1, T2 arg2, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T1	arg1
T2	arg2
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T1
T2

CallerMember<T1, T2, T3>(T1, T2, T3, string, string, int)

Declaration

public void CallerMember<T1, T2, T3>(T1 arg1, T2 arg2, T3 arg3, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T1	arg1
T2	arg2
T3	arg3
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T1
T2
T3

CallerMember<T1, T2, T3, T4>(T1, T2, T3, T4, string, string, int)

Declaration

public void CallerMember<T1, T2, T3, T4>(T1 arg1, T2 arg2, T3 arg3, T4 arg4, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T1	arg1
T2	arg2
T3	arg3
T4	arg4
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T1
T2
T3
T4

YieldInstruction<T>(T, TestInstructionExecutor, bool, CancellationToken, string, string, int)

Declaration

public void YieldInstruction<T>(T arg1, TestInstructionExecutor executor, bool throwOnError, CancellationToken cancellationToken = default, string memberName = "", string sourceFilePath = "", int sourceLineNumber = 0)

Parameters

Type	Name	Description
T	arg1
TestInstructionExecutor	executor	Test test instruction executor to use.
bool	throwOnError	Whether or not to throw on cancellation or errors.
CancellationToken	cancellationToken	Optional cancellation token to cancel the instruction prematurely.
string	memberName	Caller member name provided by compiler. May be overridden for custom operators.
string	sourceFilePath	Caller file path provided by compiler. May be overridden for custom operators.
int	sourceLineNumber	Source line number provided by compiler. May be overridden for custom operators.

Type Parameters

Name	Description
T