dotnet / dotnet/runtime

Intrinsics types use inheritdoc with ISimdVector internal type

Open
#120,081 2 comments 0 reactions 0 assignees View on GitHub
area-System.Runtime.Intrinsics documentation
Dominant language
C#
Stars
18.3k
Forks
5.6k
PR merge metrics
PR metrics pending

Description

### Description

This doesn't upset the compiler which sees these, but the docs pipeline doesn't like it.

xml/System.Runtime.Intrinsics/Vector64.xml | Warning | View | dotnetcontent | dotnet-api | system.runtime | Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNegative(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNaN(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Clamp(`0,`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinNative(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsFinite(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitudeNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNegativeInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsZero(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Clamp(`0,`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.ClampNative(`0,`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.CopySign(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsEvenInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsFinite(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNaN(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNegative(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNegativeInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNormal(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsOddInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsPositive(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsPositiveInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsSubnormal(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsZero(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Max(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitude(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitudeNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxNative(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Min(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinMagnitude(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinMagnitudeNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinNative(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Round(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Round(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Truncate(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Truncate(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsSubnormal(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Min(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxMagnitude(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsOddInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.ClampNative(`0,`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsEvenInteger(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsPositiveInfinity(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MaxNative(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsPositive(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinMagnitudeNumber(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Truncate(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Truncate(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.IsNormal(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Round(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Round(`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.MinMagnitude(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.CopySign(`0,`0)'.Line 0: [Warning] Cross reference not found: 'System.Runtime.Intrinsics.ISimdVector`2.Max(`0,`0)'.
-- | -- | -- | -- | -- | -- | --

### Reproduction Steps

Run PortToDocs tool to port runtime docs to dotnet-api-docs.

### Expected behavior

Build without warning and all API is documented

### Actual behavior

Warnings, not sure if there is missing docs or not

### Regression?

Uknown

### Known Workarounds

Undo changes made by the tool

### Configuration

_No response_

### Other information

https://github.com/dotnet/dotnet-api-docs/pull/11847
https://github.com/dotnet/dotnet-api-docs/pull/10275

@tannergooding

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.