Skip to content
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.

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

Generate documentation file #223

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,7 @@
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<LangVersion>preview</LangVersion>
<EmbedUntrackedSources>true</EmbedUntrackedSources>
<GenerateDocumentationFile>True</GenerateDocumentationFile>
</PropertyGroup>

<ItemGroup>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ public ref partial struct ValueStringBuilder
/// <summary>
/// Concatenates multiple objects together.
/// </summary>
/// <param name="values">Values, which will be concatenated together.</param>
/// <param name="values">Values to be concatenated together.</param>
/// <typeparam name="T">Any given type, which can be translated to <see cref="string"/>.</typeparam>
/// <returns>Concatenated string or an empty string if <see cref="values"/> is empty.</returns>
/// <returns>Concatenated string or an empty string if <paramref name="values"/> is empty.</returns>
[MethodImpl(MethodImplOptions.AggressiveInlining)]
public static string Concat<T>(params T[] values)
{
Expand Down
4 changes: 4 additions & 0 deletions src/LinkDotNet.StringBuilder/ValueStringBuilder.Enumerator.cs
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,10 @@ namespace LinkDotNet.StringBuilder;

public ref partial struct ValueStringBuilder
{
/// <summary>
/// Creates an enumerator over the characters in the builder.
/// </summary>
/// <returns>An enumerator over the characters in the builder.</returns>
public readonly Enumerator GetEnumerator() => new(buffer[..bufferPosition]);

/// <summary>Enumerates the elements of a <see cref="Span{T}"/>.</summary>
Expand Down
2 changes: 1 addition & 1 deletion src/LinkDotNet.StringBuilder/ValueStringBuilder.cs
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ public ValueStringBuilder(int initialCapacity)
/// <summary>
/// Returns the character at the given index or throws an <see cref="IndexOutOfRangeException"/> if the index is bigger than the string.
/// </summary>
/// <param name="index">Index position, which should be retrieved.</param>
/// <param name="index">Character position to be retrieved.</param>
public readonly ref char this[int index] => ref buffer[index];

/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public static System.Text.StringBuilder ToStringBuilder(this ValueStringBuilder
/// Creates a new <see cref="ValueStringBuilder"/> from the given <paramref name="builder"/>.
/// </summary>
/// <param name="builder">The builder from which the new instance is derived.</param>
/// <returns>A new <see cref="ValueStringBuilder"/> instance with the string represented by this <see cref="builder"/>.</returns>
/// <returns>A new <see cref="ValueStringBuilder"/> instance with the string represented by this builder.</returns>
/// <exception cref="ArgumentNullException">Throws if <paramref name="builder"/> is null.</exception>
public static ValueStringBuilder ToValueStringBuilder(this System.Text.StringBuilder? builder)
{
Expand Down
Loading