Skip to content

Commit 3c425c0

Browse files
authored
Fix doc strings for bulk get/delete users (#186)
1 parent 374ac19 commit 3c425c0

File tree

7 files changed

+18
-9
lines changed

7 files changed

+18
-9
lines changed

FirebaseAdmin/FirebaseAdmin/Auth/DeleteUsersResult.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ namespace FirebaseAdmin.Auth
2020
{
2121
/// <summary>
2222
/// Represents the result of the
23-
/// <see cref="M:FirebaseAuth.DeleteUsersAsync(IReadOnlyList{String})"/> API.
23+
/// <see cref="FirebaseAuth.DeleteUsersAsync(IReadOnlyList{string})"/> API.
2424
/// </summary>
2525
public sealed class DeleteUsersResult
2626
{
@@ -53,7 +53,7 @@ internal DeleteUsersResult(int users, BatchDeleteResponse response)
5353
/// <summary>
5454
/// Gets the number of users that were deleted successfully (possibly zero). Users that
5555
/// did not exist prior to calling
56-
/// <see cref="M:FirebaseAuth.DeleteUsersAsync(IReadOnlyList{String})"/> are considered to
56+
/// <see cref="FirebaseAuth.DeleteUsersAsync(IReadOnlyList{string})"/> are considered to
5757
/// be successfully deleted.
5858
/// </summary>
5959
public int SuccessCount { get; }

FirebaseAdmin/FirebaseAdmin/Auth/EmailIdentifier.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System.Collections.Generic;
16+
1517
namespace FirebaseAdmin.Auth
1618
{
1719
/// <summary>
1820
/// Used for looking up an account by email.
1921
///
20-
/// See <see cref="M:FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
22+
/// See <see cref="FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
2123
/// </summary>
2224
public sealed class EmailIdentifier : UserIdentifier
2325
{

FirebaseAdmin/FirebaseAdmin/Auth/ErrorInfo.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,16 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System.Collections.Generic;
16+
1517
namespace FirebaseAdmin.Auth
1618
{
1719
// TODO(rsgowman): This class is expected to also be used for the
1820
// ImportUsersAsync() method... once that exists.
1921

2022
/// <summary>
2123
/// Represents an error encountered while deleting users via the
22-
/// <see cref="M:FirebaseAuth.DeleteUsersAsync(IReadOnlyList{String})"/> API.
24+
/// <see cref="FirebaseAuth.DeleteUsersAsync(IReadOnlyList{string})"/> API.
2325
/// </summary>
2426
public sealed class ErrorInfo
2527
{
@@ -31,7 +33,7 @@ internal ErrorInfo(int index, string reason)
3133

3234
/// <summary>
3335
/// Gets the index of the user that was unable to be deleted in the list passed to the
34-
/// <see cref="M:FirebaseAuth.DeleteUsersAsync(IReadOnlyList{String})"/> method.
36+
/// <see cref="FirebaseAuth.DeleteUsersAsync(IReadOnlyList{string})"/> method.
3537
/// </summary>
3638
public int Index { get; }
3739

FirebaseAdmin/FirebaseAdmin/Auth/GetUsersResult.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@
1818
namespace FirebaseAdmin.Auth
1919
{
2020
/// <summary>
21-
/// Represents the result of the <see cref="M:FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/> API.
21+
/// Represents the result of the <see cref="FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/> API.
2222
/// </summary>
2323
public sealed class GetUsersResult
2424
{

FirebaseAdmin/FirebaseAdmin/Auth/PhoneIdentifier.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System.Collections.Generic;
16+
1517
namespace FirebaseAdmin.Auth
1618
{
1719
/// <summary>
1820
/// Used for looking up an account by phone number.
1921
///
20-
/// See <see cref="M:FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
22+
/// See <see cref="FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
2123
/// </summary>
2224
public sealed class PhoneIdentifier : UserIdentifier
2325
{

FirebaseAdmin/FirebaseAdmin/Auth/ProviderIdentifier.cs

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,15 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System.Collections.Generic;
1516
using System.Linq;
1617

1718
namespace FirebaseAdmin.Auth
1819
{
1920
/// <summary>
2021
/// Used for looking up an account by provider.
2122
///
22-
/// See <see cref="M:FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
23+
/// See <see cref="FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
2324
/// </summary>
2425
public sealed class ProviderIdentifier : UserIdentifier
2526
{

FirebaseAdmin/FirebaseAdmin/Auth/UidIdentifier.cs

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@
1212
// See the License for the specific language governing permissions and
1313
// limitations under the License.
1414

15+
using System.Collections.Generic;
16+
1517
namespace FirebaseAdmin.Auth
1618
{
1719
/// <summary>
1820
/// Used for looking up an account by uid.
1921
///
20-
/// See <see cref="M:FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
22+
/// See <see cref="FirebaseAuth.GetUsersAsync(IReadOnlyCollection{UserIdentifier})"/>.
2123
/// </summary>
2224
public sealed class UidIdentifier : UserIdentifier
2325
{

0 commit comments

Comments
 (0)