Skip to content

#945509 Support ref readonly parameters #712

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Oct 30, 2025
Merged

#945509 Support ref readonly parameters #712

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4bac65
#945509 Support ref readonly parameters
nickwalkmsft Sep 11, 2024
e4e60fe
merge
bianyifan Oct 29, 2025
54cfbf3
rev
bianyifan Oct 29, 2025
49f0428
test
bianyifan Oct 29, 2025
2fbf1a3
ver
bianyifan Oct 29, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added external/Test/RefReadonlyParameter.dll
View file
Open in desktop
Binary file not shown.
3 changes: 2 additions & 1 deletion mdoc/Consts.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ namespace Mono.Documentation
{
public static class Consts
{
public static string MonoVersion = "5.9.4";
public static string MonoVersion = "5.9.5";
public const string DocId = "DocId";
public const string CppCli = "C++ CLI";
public const string CppCx = "C++ CX";
Expand Down Expand Up @@ -49,6 +49,7 @@ public static class Consts
public const string CompilerGeneratedAttribute = "System.Runtime.CompilerServices.CompilerGeneratedAttribute";
public const string IsByRefLikeAttribute = "System.Runtime.CompilerServices.IsByRefLikeAttribute";
public const string IsReadOnlyAttribute = "System.Runtime.CompilerServices.IsReadOnlyAttribute";
public const string RequiresLocationAttribute = "System.Runtime.CompilerServices.RequiresLocationAttribute";
public const string InAttribute = "System.Runtime.InteropServices.InAttribute";
public const string OutAttribute = "System.Runtime.InteropServices.OutAttribute";
public const string TupleElementNamesAttribute = "System.Runtime.CompilerServices.TupleElementNamesAttribute";
Expand Down
8 changes: 6 additions & 2 deletions mdoc/Mono.Documentation/Updater/Formatters/CSharpFullMemberFormatter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,7 +619,7 @@ private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition meth
protected override StringBuilder AppendParameter(StringBuilder buf, ParameterDefinition parameter)
{
TypeReference parameterType = parameter.ParameterType;
var refType = new BitArray(3);
var refType = new BitArray(4);

if (parameter.HasCustomAttributes)
{
Expand Down Expand Up @@ -650,14 +650,18 @@ protected override StringBuilder AppendParameter(StringBuilder buf, ParameterDef
{
refType.Set(0, true);
}
else if (parameter.IsIn && DocUtils.HasCustomAttribute(parameter, Consts.RequiresLocationAttribute))
{
refType.Set(3, true);
}
else
{
refType.Set(2, true);
}
parameterType = byReferenceType.ElementType;
}

buf.Append(refType.Get(0) ? "in " : (refType.Get(1) ? "out " : (refType.Get(2) ? "ref ": "")));
buf.Append(refType.Get(0) ? "in " : (refType.Get(1) ? "out " : (refType.Get(2) ? "ref ": (refType.Get(3) ? "ref readonly " : ""))));

if (parameter.HasCustomAttributes)
{
Expand Down
6 changes: 6 additions & 0 deletions mdoc/mdoc.Test/FormatterTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -619,6 +619,12 @@ public void CSharpAllowsRefStructForMemberTest(string typeFullName, string metho
TestMethodSignature(allowsRefStructDllPath, typeFullName, methodName, expectedSignature);
}

[TestCase("SomeClass", "MethodWithRefReadOnlyParam", "public void MethodWithRefReadOnlyParam (ref readonly int i);")]
public void CSharpRefReadonlyTest(string typeFullName, string methodName, string expectedSignature)
{
TestMethodSignature("../../../../external/Test/RefReadonlyParameter.dll", typeFullName, methodName, expectedSignature);
}

#region Helper Methods
string RealTypeName(string name){
switch (name) {
Expand Down
2 changes: 1 addition & 1 deletion mdoc/mdoc.nuspec
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<package >
<metadata>
<id>mdoc</id>
<version>5.9.4</version>
<version>5.9.5</version>
<title>mdoc</title>
<authors>Microsoft</authors>
<owners>Microsoft</owners>
Expand Down