Problem
The XML documentation comment for AndroidMessageHandler.ConnectTimeout states the default value is 120 seconds, but the actual default is TimeSpan.FromHours(24) (24 hours). This misleads developers who rely on IntelliSense documentation without checking the source code.
Location
- File:
src/Mono.Android/Xamarin.Android.Net/AndroidMessageHandler.cs
- Lines: 458–472
Current Code
/// <para>
/// The default value is <c>120</c> seconds.
/// </para>
/// </summary>
public TimeSpan ConnectTimeout { get; set; } = TimeSpan.FromHours (24);
The doc says "120 seconds" but the initializer is TimeSpan.FromHours (24).
Note that the adjacent ReadTimeout property (line 448) correctly documents its default as "24 hours" and also uses TimeSpan.FromHours (24), confirming ConnectTimeout should say the same.
Suggested Fix
Change the doc comment from:
/// The default value is <c>120</c> seconds.
to:
/// The default value is <c>24</c> hours, same as <see cref="ReadTimeout"/>.
Guidelines
- Only change the XML doc comment, no logic changes
- Keep style consistent with the
ReadTimeout doc comment above it
Acceptance Criteria
Generated by Nightly Fix Finder · ● 13.3M · ◷
Problem
The XML documentation comment for
AndroidMessageHandler.ConnectTimeoutstates the default value is120seconds, but the actual default isTimeSpan.FromHours(24)(24 hours). This misleads developers who rely on IntelliSense documentation without checking the source code.Location
src/Mono.Android/Xamarin.Android.Net/AndroidMessageHandler.csCurrent Code
The doc says "120 seconds" but the initializer is
TimeSpan.FromHours (24).Note that the adjacent
ReadTimeoutproperty (line 448) correctly documents its default as "24 hours" and also usesTimeSpan.FromHours (24), confirmingConnectTimeoutshould say the same.Suggested Fix
Change the doc comment from:
/// The default value is <c>120</c> seconds.to:
/// The default value is <c>24</c> hours, same as <see cref="ReadTimeout"/>.Guidelines
ReadTimeoutdoc comment above itAcceptance Criteria
ConnectTimeoutXML doc comment accurately states the default is 24 hours