refactor project structure and add documents.
This commit is contained in:
@@ -0,0 +1,421 @@
|
||||
### YamlMime:ManagedReference
|
||||
items:
|
||||
- uid: Misaki.HighPerformance.Jobs.IJobExtensions
|
||||
commentId: T:Misaki.HighPerformance.Jobs.IJobExtensions
|
||||
id: IJobExtensions
|
||||
parent: Misaki.HighPerformance.Jobs
|
||||
children:
|
||||
- Misaki.HighPerformance.Jobs.IJobExtensions.RunRef``1(``0@,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
- Misaki.HighPerformance.Jobs.IJobExtensions.Run``1(``0,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
langs:
|
||||
- csharp
|
||||
- vb
|
||||
name: IJobExtensions
|
||||
nameWithType: IJobExtensions
|
||||
fullName: Misaki.HighPerformance.Jobs.IJobExtensions
|
||||
type: Class
|
||||
source:
|
||||
remote:
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
branch: main
|
||||
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
|
||||
id: IJobExtensions
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
startLine: 77
|
||||
assemblies:
|
||||
- Misaki.HighPerformance.Jobs
|
||||
namespace: Misaki.HighPerformance.Jobs
|
||||
syntax:
|
||||
content: public static class IJobExtensions
|
||||
content.vb: Public Module IJobExtensions
|
||||
inheritance:
|
||||
- System.Object
|
||||
inheritedMembers:
|
||||
- System.Object.Equals(System.Object)
|
||||
- System.Object.Equals(System.Object,System.Object)
|
||||
- System.Object.GetHashCode
|
||||
- System.Object.GetType
|
||||
- System.Object.MemberwiseClone
|
||||
- System.Object.ReferenceEquals(System.Object,System.Object)
|
||||
- System.Object.ToString
|
||||
- uid: Misaki.HighPerformance.Jobs.IJobExtensions.Run``1(``0,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
commentId: M:Misaki.HighPerformance.Jobs.IJobExtensions.Run``1(``0,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
id: Run``1(``0,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
isExtensionMethod: true
|
||||
parent: Misaki.HighPerformance.Jobs.IJobExtensions
|
||||
langs:
|
||||
- csharp
|
||||
- vb
|
||||
name: Run<T>(T, ref readonly JobExecutionContext)
|
||||
nameWithType: IJobExtensions.Run<T>(T, ref readonly JobExecutionContext)
|
||||
fullName: Misaki.HighPerformance.Jobs.IJobExtensions.Run<T>(T, ref readonly Misaki.HighPerformance.Jobs.JobExecutionContext)
|
||||
type: Method
|
||||
source:
|
||||
remote:
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
branch: main
|
||||
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
|
||||
id: Run
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
startLine: 85
|
||||
assemblies:
|
||||
- Misaki.HighPerformance.Jobs
|
||||
namespace: Misaki.HighPerformance.Jobs
|
||||
summary: Runs the job in the calling thread, blocking until the job is complete.
|
||||
example: []
|
||||
syntax:
|
||||
content: 'public static void Run<T>(this T job, ref readonly JobExecutionContext ctx) where T : IJob'
|
||||
parameters:
|
||||
- id: job
|
||||
type: '{T}'
|
||||
description: The job to run.
|
||||
- id: ctx
|
||||
type: Misaki.HighPerformance.Jobs.JobExecutionContext
|
||||
description: The job execution context.
|
||||
typeParameters:
|
||||
- id: T
|
||||
description: The type of the job.
|
||||
content.vb: Public Shared Sub Run(Of T As IJob)(job As T, ctx As JobExecutionContext)
|
||||
overload: Misaki.HighPerformance.Jobs.IJobExtensions.Run*
|
||||
nameWithType.vb: IJobExtensions.Run(Of T)(T, JobExecutionContext)
|
||||
fullName.vb: Misaki.HighPerformance.Jobs.IJobExtensions.Run(Of T)(T, Misaki.HighPerformance.Jobs.JobExecutionContext)
|
||||
name.vb: Run(Of T)(T, JobExecutionContext)
|
||||
- uid: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef``1(``0@,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
commentId: M:Misaki.HighPerformance.Jobs.IJobExtensions.RunRef``1(``0@,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
id: RunRef``1(``0@,Misaki.HighPerformance.Jobs.JobExecutionContext@)
|
||||
isExtensionMethod: true
|
||||
parent: Misaki.HighPerformance.Jobs.IJobExtensions
|
||||
langs:
|
||||
- csharp
|
||||
- vb
|
||||
name: RunRef<T>(ref T, ref readonly JobExecutionContext)
|
||||
nameWithType: IJobExtensions.RunRef<T>(ref T, ref readonly JobExecutionContext)
|
||||
fullName: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef<T>(ref T, ref readonly Misaki.HighPerformance.Jobs.JobExecutionContext)
|
||||
type: Method
|
||||
source:
|
||||
remote:
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
branch: main
|
||||
repo: https://git.personalnas.com/Misaki/Misaki.HighPerformance.git
|
||||
id: RunRef
|
||||
path: src/Misaki.HighPerformance.Jobs/IJob.cs
|
||||
startLine: 97
|
||||
assemblies:
|
||||
- Misaki.HighPerformance.Jobs
|
||||
namespace: Misaki.HighPerformance.Jobs
|
||||
summary: Runs the job by reference in the calling thread, blocking until the job is complete.
|
||||
example: []
|
||||
syntax:
|
||||
content: 'public static void RunRef<T>(this ref T job, ref readonly JobExecutionContext ctx) where T : struct, IJob'
|
||||
parameters:
|
||||
- id: job
|
||||
type: '{T}'
|
||||
description: The job to run.
|
||||
- id: ctx
|
||||
type: Misaki.HighPerformance.Jobs.JobExecutionContext
|
||||
description: The job execution context.
|
||||
typeParameters:
|
||||
- id: T
|
||||
description: The type of the job.
|
||||
content.vb: Public Shared Sub RunRef(Of T As {Structure, IJob})(job As T, ctx As JobExecutionContext)
|
||||
overload: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef*
|
||||
nameWithType.vb: IJobExtensions.RunRef(Of T)(T, JobExecutionContext)
|
||||
fullName.vb: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef(Of T)(T, Misaki.HighPerformance.Jobs.JobExecutionContext)
|
||||
name.vb: RunRef(Of T)(T, JobExecutionContext)
|
||||
references:
|
||||
- uid: Misaki.HighPerformance.Jobs
|
||||
commentId: N:Misaki.HighPerformance.Jobs
|
||||
href: Misaki.html
|
||||
name: Misaki.HighPerformance.Jobs
|
||||
nameWithType: Misaki.HighPerformance.Jobs
|
||||
fullName: Misaki.HighPerformance.Jobs
|
||||
spec.csharp:
|
||||
- uid: Misaki
|
||||
name: Misaki
|
||||
href: Misaki.html
|
||||
- name: .
|
||||
- uid: Misaki.HighPerformance
|
||||
name: HighPerformance
|
||||
href: Misaki.HighPerformance.html
|
||||
- name: .
|
||||
- uid: Misaki.HighPerformance.Jobs
|
||||
name: Jobs
|
||||
href: Misaki.HighPerformance.Jobs.html
|
||||
spec.vb:
|
||||
- uid: Misaki
|
||||
name: Misaki
|
||||
href: Misaki.html
|
||||
- name: .
|
||||
- uid: Misaki.HighPerformance
|
||||
name: HighPerformance
|
||||
href: Misaki.HighPerformance.html
|
||||
- name: .
|
||||
- uid: Misaki.HighPerformance.Jobs
|
||||
name: Jobs
|
||||
href: Misaki.HighPerformance.Jobs.html
|
||||
- uid: System.Object
|
||||
commentId: T:System.Object
|
||||
parent: System
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
name: object
|
||||
nameWithType: object
|
||||
fullName: object
|
||||
nameWithType.vb: Object
|
||||
fullName.vb: Object
|
||||
name.vb: Object
|
||||
- uid: System.Object.Equals(System.Object)
|
||||
commentId: M:System.Object.Equals(System.Object)
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
||||
name: Equals(object)
|
||||
nameWithType: object.Equals(object)
|
||||
fullName: object.Equals(object)
|
||||
nameWithType.vb: Object.Equals(Object)
|
||||
fullName.vb: Object.Equals(Object)
|
||||
name.vb: Equals(Object)
|
||||
spec.csharp:
|
||||
- uid: System.Object.Equals(System.Object)
|
||||
name: Equals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.Equals(System.Object)
|
||||
name: Equals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
- uid: System.Object.Equals(System.Object,System.Object)
|
||||
commentId: M:System.Object.Equals(System.Object,System.Object)
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
||||
name: Equals(object, object)
|
||||
nameWithType: object.Equals(object, object)
|
||||
fullName: object.Equals(object, object)
|
||||
nameWithType.vb: Object.Equals(Object, Object)
|
||||
fullName.vb: Object.Equals(Object, Object)
|
||||
name.vb: Equals(Object, Object)
|
||||
spec.csharp:
|
||||
- uid: System.Object.Equals(System.Object,System.Object)
|
||||
name: Equals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: ','
|
||||
- name: " "
|
||||
- uid: System.Object
|
||||
name: object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.Equals(System.Object,System.Object)
|
||||
name: Equals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: ','
|
||||
- name: " "
|
||||
- uid: System.Object
|
||||
name: Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
- uid: System.Object.GetHashCode
|
||||
commentId: M:System.Object.GetHashCode
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
||||
name: GetHashCode()
|
||||
nameWithType: object.GetHashCode()
|
||||
fullName: object.GetHashCode()
|
||||
nameWithType.vb: Object.GetHashCode()
|
||||
fullName.vb: Object.GetHashCode()
|
||||
spec.csharp:
|
||||
- uid: System.Object.GetHashCode
|
||||
name: GetHashCode
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
||||
- name: (
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.GetHashCode
|
||||
name: GetHashCode
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
|
||||
- name: (
|
||||
- name: )
|
||||
- uid: System.Object.GetType
|
||||
commentId: M:System.Object.GetType
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
||||
name: GetType()
|
||||
nameWithType: object.GetType()
|
||||
fullName: object.GetType()
|
||||
nameWithType.vb: Object.GetType()
|
||||
fullName.vb: Object.GetType()
|
||||
spec.csharp:
|
||||
- uid: System.Object.GetType
|
||||
name: GetType
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
||||
- name: (
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.GetType
|
||||
name: GetType
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
|
||||
- name: (
|
||||
- name: )
|
||||
- uid: System.Object.MemberwiseClone
|
||||
commentId: M:System.Object.MemberwiseClone
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
||||
name: MemberwiseClone()
|
||||
nameWithType: object.MemberwiseClone()
|
||||
fullName: object.MemberwiseClone()
|
||||
nameWithType.vb: Object.MemberwiseClone()
|
||||
fullName.vb: Object.MemberwiseClone()
|
||||
spec.csharp:
|
||||
- uid: System.Object.MemberwiseClone
|
||||
name: MemberwiseClone
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
||||
- name: (
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.MemberwiseClone
|
||||
name: MemberwiseClone
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
|
||||
- name: (
|
||||
- name: )
|
||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
||||
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
||||
name: ReferenceEquals(object, object)
|
||||
nameWithType: object.ReferenceEquals(object, object)
|
||||
fullName: object.ReferenceEquals(object, object)
|
||||
nameWithType.vb: Object.ReferenceEquals(Object, Object)
|
||||
fullName.vb: Object.ReferenceEquals(Object, Object)
|
||||
name.vb: ReferenceEquals(Object, Object)
|
||||
spec.csharp:
|
||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
||||
name: ReferenceEquals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: ','
|
||||
- name: " "
|
||||
- uid: System.Object
|
||||
name: object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
|
||||
name: ReferenceEquals
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
|
||||
- name: (
|
||||
- uid: System.Object
|
||||
name: Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: ','
|
||||
- name: " "
|
||||
- uid: System.Object
|
||||
name: Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object
|
||||
- name: )
|
||||
- uid: System.Object.ToString
|
||||
commentId: M:System.Object.ToString
|
||||
parent: System.Object
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
||||
name: ToString()
|
||||
nameWithType: object.ToString()
|
||||
fullName: object.ToString()
|
||||
nameWithType.vb: Object.ToString()
|
||||
fullName.vb: Object.ToString()
|
||||
spec.csharp:
|
||||
- uid: System.Object.ToString
|
||||
name: ToString
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
||||
- name: (
|
||||
- name: )
|
||||
spec.vb:
|
||||
- uid: System.Object.ToString
|
||||
name: ToString
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
|
||||
- name: (
|
||||
- name: )
|
||||
- uid: System
|
||||
commentId: N:System
|
||||
isExternal: true
|
||||
href: https://learn.microsoft.com/dotnet/api/system
|
||||
name: System
|
||||
nameWithType: System
|
||||
fullName: System
|
||||
- uid: Misaki.HighPerformance.Jobs.IJobExtensions.Run*
|
||||
commentId: Overload:Misaki.HighPerformance.Jobs.IJobExtensions.Run
|
||||
href: Misaki.HighPerformance.Jobs.IJobExtensions.html#Misaki_HighPerformance_Jobs_IJobExtensions_Run__1___0_Misaki_HighPerformance_Jobs_JobExecutionContext__
|
||||
name: Run
|
||||
nameWithType: IJobExtensions.Run
|
||||
fullName: Misaki.HighPerformance.Jobs.IJobExtensions.Run
|
||||
- uid: '{T}'
|
||||
commentId: '!:T'
|
||||
definition: T
|
||||
name: T
|
||||
nameWithType: T
|
||||
fullName: T
|
||||
- uid: Misaki.HighPerformance.Jobs.JobExecutionContext
|
||||
commentId: T:Misaki.HighPerformance.Jobs.JobExecutionContext
|
||||
parent: Misaki.HighPerformance.Jobs
|
||||
href: Misaki.HighPerformance.Jobs.JobExecutionContext.html
|
||||
name: JobExecutionContext
|
||||
nameWithType: JobExecutionContext
|
||||
fullName: Misaki.HighPerformance.Jobs.JobExecutionContext
|
||||
- uid: T
|
||||
name: T
|
||||
nameWithType: T
|
||||
fullName: T
|
||||
- uid: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef*
|
||||
commentId: Overload:Misaki.HighPerformance.Jobs.IJobExtensions.RunRef
|
||||
href: Misaki.HighPerformance.Jobs.IJobExtensions.html#Misaki_HighPerformance_Jobs_IJobExtensions_RunRef__1___0__Misaki_HighPerformance_Jobs_JobExecutionContext__
|
||||
name: RunRef
|
||||
nameWithType: IJobExtensions.RunRef
|
||||
fullName: Misaki.HighPerformance.Jobs.IJobExtensions.RunRef
|
||||
Reference in New Issue
Block a user