Skip to content

Commit

Permalink
Use autoUpgrade="true" for referencing a method group in documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sharwell committed Jun 22, 2017
1 parent caa4c82 commit 7271fab
Show file tree
Hide file tree
Showing 4 changed files with 10 additions and 8 deletions.
2 changes: 1 addition & 1 deletion NOpenCL/BinaryType.cs
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public enum BinaryType
/// <summary>
/// An executable binary is associated with the device. This is the case if a
/// program was created by <see cref="Program.Link"/> without the <c>–createlibrary</c>
/// link option or the program was created by <see cref="O:NOpenCL.Program.Build"/>
/// link option or the program was created by <see cref="Program.Build()" autoUpgrade="true"/>
/// or an executable binary is loaded using <see cref="Context.CreateProgramWithBinary"/>.
/// </summary>
Executable = 0x0004,
Expand Down
2 changes: 1 addition & 1 deletion NOpenCL/BuildStatus.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace NOpenCL
/// Returns the build, compile, or link status, whichever was performed last
/// on the specified program and device.
/// </summary>
/// <seealso cref="O:NOpenCL.Program.Build"/>
/// <seealso cref="Program.Build()" autoUpgrade="true"/>
/// <seealso cref="Program.Compile"/>
/// <seealso cref="Program.Link"/>
public enum BuildStatus
Expand Down
8 changes: 5 additions & 3 deletions NOpenCL/Device.cs
Original file line number Diff line number Diff line change
Expand Up @@ -478,7 +478,8 @@ public uint MaxSamplers
/// <summary>
/// Maximum number of work-items in a work-group executing a kernel on a single
/// compute unit, using the data parallel execution model.
/// (Refer to <see cref="O:NOpenCL.CommandQueue.EnqueueNDRangeKernel"/>). The minimum value is 1.
/// (Refer to <see cref="CommandQueue.EnqueueNDRangeKernel(Kernel, IntPtr, IntPtr, Event[])" autoUpgrade="true"/>).
/// The minimum value is 1.
/// </summary>
public UIntPtr MaxWorkGroupSize
{
Expand All @@ -490,7 +491,8 @@ public UIntPtr MaxWorkGroupSize

/// <summary>
/// Maximum dimensions that specify the global and local work-item IDs used by
/// the data parallel execution model. (Refer to <see cref="O:NOpenCL.CommandQueue.EnqueueNDRangeKernel"/>). The
/// the data parallel execution model. (Refer to
/// <see cref="CommandQueue.EnqueueNDRangeKernel(Kernel, IntPtr, IntPtr, Event[])" autoUpgrade="true"/>). The
/// minimum value is 3 for devices that are not of type <see cref="NOpenCL.DeviceType.Custom"/>.
/// </summary>
public uint MaxWorkItemDimensions
Expand All @@ -503,7 +505,7 @@ public uint MaxWorkItemDimensions

/// <summary>
/// Maximum number of work-items that can be specified in each dimension of
/// the work-group to <see cref="O:NOpenCL.CommandQueue.EnqueueNDRangeKernel"/>.
/// the work-group to <see cref="CommandQueue.EnqueueNDRangeKernel(Kernel, IntPtr, IntPtr, Event[])" autoUpgrade="true"/>.
/// <para/>
/// Returns <em>n</em> <see cref="IntPtr"/> entries, where <em>n</em> is the
/// value returned by the query for <see cref="MaxWorkItemDimensions"/>.
Expand Down
6 changes: 3 additions & 3 deletions NOpenCL/Platform.cs
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,9 @@ public Device[] GetDevices(DeviceType deviceType)
/// <remarks>
/// This is a hint from the application and does not guarantee that the compiler will not be used
/// in the future or that the compiler will actually be unloaded by the implementation. Calls to
/// <see cref="O:NOpenCL.Program.Build"/>, <see cref="Program.Compile"/>, or <see cref="Context.LinkProgram"/>
/// after <see cref="UnloadCompiler"/> will reload the compiler, if necessary, to build the
/// appropriate program executable.
/// <see cref="Program.Build()" autoUpgrade="true"/>, <see cref="Program.Compile"/>, or
/// <see cref="Context.LinkProgram"/> after <see cref="UnloadCompiler"/> will reload the compiler, if necessary,
/// to build the appropriate program executable.
/// </remarks>
public void UnloadCompiler()
#pragma warning restore CS1574 // XML comment has cref attribute that could not be resolved
Expand Down

0 comments on commit 7271fab

Please sign in to comment.