Skip to content

Commit 414129e

Browse files
committed
Add NamespaceDoc
1 parent 61bf89d commit 414129e

9 files changed

Lines changed: 83 additions & 7 deletions

File tree

AdvancedSharpAdbClient.WinRT/AdbClient.cs

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -54,6 +54,12 @@ public sealed class AdbClient : IAdbClient, IAdbClientAsync, IDeviceExtensions,
5454
/// </summary>
5555
public static int DefaultAdbServerPort { get; } = AdvancedSharpAdbClient.AdbClient.DefaultAdbServerPort;
5656

57+
/// <summary>
58+
/// Gets a new instance of the <see cref="AdbClient"/> class.
59+
/// </summary>
60+
[Deprecated("This function has been removed since SharpAdbClient. Here is a placeholder which function is gets a new instance instead of gets or sets the default instance.", DeprecationType.Deprecate, 65536)]
61+
public static AdbClient Instance => new();
62+
5763
/// <summary>
5864
/// Initializes a new instance of the <see cref="AdbClient"/> class.
5965
/// </summary>

AdvancedSharpAdbClient.WinRT/AdbServer.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
using AdvancedSharpAdbClient.WinRT.Extensions;
22
using System.Runtime.InteropServices.WindowsRuntime;
3-
using System.Threading;
43
using Windows.ApplicationModel;
54
using Windows.Foundation;
65

AdvancedSharpAdbClient.WinRT/AdbSocket.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ public static int WriteBufferSize
126126

127127
/// <inheritdoc/>
128128
public IAsyncAction SendAdbRequestAsync(string request) => AsyncInfo.Run((cancellationToken) => adbSocket.SendAdbRequestAsync(request, cancellationToken));
129-
129+
130130
/// <inheritdoc/>
131131
public int Read([WriteOnlyArray] byte[] data) => adbSocket.Read(data);
132132

AdvancedSharpAdbClient.WinRT/AdvancedSharpAdbClient.WinRT.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
<PropertyGroup Condition="'$(TargetFramework)' == 'net6.0-windows10.0.17763.0'">
2727
<CsWinRTComponent>true</CsWinRTComponent>
2828
<CsWinRTWindowsMetadata>10.0.22621.0</CsWinRTWindowsMetadata>
29-
<NoWarn>CS1591</NoWarn>
29+
<NoWarn>CS0618;CS1591</NoWarn>
3030
<Platforms>x64;x86;ARM64;ARM</Platforms>
3131
</PropertyGroup>
3232

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
// <copyright file="NamespaceDoc.cs" company="The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere">
2+
// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
3+
// </copyright>
4+
5+
using System.Runtime.CompilerServices;
6+
7+
namespace AdvancedSharpAdbClient.WinRT.DeviceCommands
8+
{
9+
/// <summary>
10+
/// The classes in this namespace provide Device Commands of adb.
11+
/// </summary>
12+
/// <remarks><c>Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.</c></remarks>
13+
[CompilerGenerated]
14+
internal class NamespaceDoc { }
15+
}

AdvancedSharpAdbClient.WinRT/Interfaces/IAdbCommandLineClient.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
33
// </copyright>
44

5-
using System;
65
using Windows.ApplicationModel;
76

87
namespace AdvancedSharpAdbClient.WinRT

AdvancedSharpAdbClient.WinRT/Models/DeviceDataEventArgs.cs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@
22
// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
33
// </copyright>
44

5-
using System;
65
using System.Collections.Generic;
76
using System.Linq;
87

AdvancedSharpAdbClient.WinRT/Models/Element.cs

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,6 @@
66
using System.Collections.Generic;
77
using System.Linq;
88
using System.Runtime.InteropServices.WindowsRuntime;
9-
using System.Xml;
10-
using System.Xml.Linq;
119
using Windows.Data.Xml.Dom;
1210
using Windows.Foundation;
1311
using XmlDocument = Windows.Data.Xml.Dom.XmlDocument;
Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
// <copyright file="NamespaceDoc.cs" company="The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere">
2+
// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
3+
// </copyright>
4+
5+
using System.Runtime.CompilerServices;
6+
7+
namespace AdvancedSharpAdbClient.WinRT
8+
{
9+
/// <summary>
10+
///
11+
/// <para>
12+
/// AdvancedSharpAdbClient is a .NET library that allows.NET applications to communicate with Android devices.
13+
/// It provides a.NET implementation of the <c>adb</c> protocol, giving more flexibility to the developer than launching an
14+
/// <c>adb.exe</c> process and parsing the console output.
15+
/// </para>
16+
///
17+
/// <para>
18+
/// Most of the adb functionality is exposed through the <see cref="AdbClient"/> class.
19+
/// You can create your own instance of that class, or just use the instance we provide for you at
20+
/// <see cref="AdbClient.Instance"/>
21+
/// </para>
22+
///
23+
/// <para>
24+
/// To send and receive files to and from Android devices, you can use the <see cref="SyncService"/> class.
25+
/// </para>
26+
///
27+
/// <para>
28+
/// To be notified when Android devices connect to or disconnect from your PC, you can use the <see cref="DeviceMonitor"/>
29+
/// class.
30+
/// </para>
31+
///
32+
/// </summary>
33+
///
34+
/// <example>
35+
///
36+
/// <para>
37+
/// To list all Android devices that are connected to your PC, you can use the following code:
38+
/// </para>
39+
///
40+
/// <code>
41+
/// var devices = devices = new AdbClient().GetDevices();
42+
///
43+
/// foreach(var device in devices)
44+
/// {
45+
/// Console.WriteLine(device.Name);
46+
/// }
47+
/// </code>
48+
///
49+
/// </example>
50+
///
51+
/// <remarks>
52+
///
53+
/// <c>
54+
/// Copyright (c) The Android Open Source Project, Ryan Conrad, Quamotion, yungd1plomat, wherewhere. All rights reserved.
55+
/// </c>
56+
///
57+
/// </remarks>
58+
[CompilerGenerated]
59+
internal class NamespaceDoc { }
60+
}

0 commit comments

Comments
 (0)