Port System.Runtime.Intrinsics new docs#10155
Port System.Runtime.Intrinsics new docs#10155carlossanlop wants to merge 5 commits intodotnet:mainfrom carlossanlop:PortSystemRuntimeIntrinsics
Conversation
This comment was marked as outdated.
This comment was marked as outdated.
| <param name="upper">To be added.</param> | ||
| <param name="value">To be added.</param> | ||
| <summary>To be added.</summary> | ||
| <summary>__m128d _mm_cvtsi64_sd (__m128d a, __int64 b) VCVTUSI2SD xmm1, xmm2, r/m64 This intrinsic is only available on 64-bit processes</summary> |
There was a problem hiding this comment.
Should "This intrinsic is only available on 64-bit processes" be in the remarks instead?
There was a problem hiding this comment.
I think there's a lot of missing newlines or <para> separators in these as well
There was a problem hiding this comment.
@tannergooding I don't see the comments in triple slash split by <para>.
There was a problem hiding this comment.
They're split by newline in the triple slash, which I don't think has been an issue with the other intrinsic docs; unless we manually fixed those all up in the docs?
There was a problem hiding this comment.
I think there's a bug in the tool. I was expecting it to split new lines using <para>. I fixed it manually. Can you please take another look?
|
@tannergooding @gewarren bad news: The compiler generated xmls do not preserve the type in generic types. For example: /// <summary>Converts a <see cref="Vector64{Single}" /> to a <see cref="Vector64{Int32}" /> using platform specific behavior on overflow.</summary>
/// <param name="vector">The vector to convert.</param>
/// <returns>The converted vector.</returns>
[Intrinsic]
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static unsafe Vector64<int> ConvertToInt32Native(Vector64<float> vector)When built, shows the following output under So our options are:
|
If there's a preferred way to state it instead of Perhaps |
|
Would appreciate weigh-in from @gewarren on the preferred way for this to be "displayed" or otherwise surfaced for the docs page side of things, and then I can automate the replacement For returns and similar, we do: Vector128<Int32> Where the first links to the So if there were maybe something like |
My preference would just be use code tags or langword instead of |
Thank you so much, @tannergooding. It's really frustrating that the intellisense xmls do not respect it when they're generated. |
|
Closing in favor of #10275. |
@dotnet/area-system-runtime-intrinsics @directhex @gewarren PTAL