Skip to content

Commit

Permalink
Add documentation comments
Browse files Browse the repository at this point in the history
  • Loading branch information
nloum committed Nov 10, 2024
1 parent e510dc0 commit d485136
Showing 1 changed file with 16 additions and 0 deletions.
16 changes: 16 additions & 0 deletions CodegenBot/CaretRef.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,25 @@ namespace CodegenBot;
/// </summary>
public class CaretRef
{
/// <summary>
/// The caret ID, which is used to uniquely identifier the caret. E.g. you might call
/// GraphQLClient.AddText(myCaret.Id, "...") to insert text at this caret.
/// </summary>
public required string Id { get; init; }
/// <summary>
/// The separator between text inserted into this caret. If this is an empty string then no text is inserted between
/// items inserted into this caret.
/// </summary>
public required string Separator { get; init; }
/// <summary>
/// The amount of indentation to use when newlines are inserted into this text. An empty string means no extra indentation
/// will be used. This only affects indentation added automatically by Codegen Bot.
/// </summary>
public required string Indentation { get; init; }
/// <summary>
/// The metadata for this caret, to be used for calls like GraphQLClient.AddTextByTag. This is useful for adding text
/// to a caret whose ID you don't know (e.g. if the caret was created by a different bot).
/// </summary>
public IReadOnlyList<CaretTag>? Tags { get; init; }

public static CaretRef New(string id, string separator = "", string indentation = "")
Expand Down

0 comments on commit d485136

Please sign in to comment.