Skip to content

Commit a034356

Browse files
Copilotsamtrion
andcommitted
docs: complete API reference with all available methods and overloads
Co-authored-by: samtrion <[email protected]>
1 parent 273975a commit a034356

File tree

1 file changed

+61
-22
lines changed

1 file changed

+61
-22
lines changed

README.md

Lines changed: 61 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -357,11 +357,25 @@ public string GenerateInterface(string interfaceName, List<MethodSignature> meth
357357
| Method | Description |
358358
|--------|-------------|
359359
| `Append(string)` | Appends a string to the builder |
360+
| `Append(string, int, int)` | Appends a substring starting at specified index with specified count |
361+
| `Append(bool)` | Appends the string representation of a Boolean value |
362+
| `Append(char)` | Appends a character to the builder |
363+
| `Append(char, int)` | Appends a character repeated the specified number of times |
364+
| `Append(char[])` | Appends a character array to the builder |
365+
| `Append(char[], int, int)` | Appends a subset of a character array |
366+
| `Append(ReadOnlyMemory<char>)` | Appends read-only memory of characters |
367+
| `Append(ReadOnlyMemory<char>, int, int)` | Appends subset of read-only memory |
368+
| `Append(char*, int)` | Appends characters from unsafe pointer (unsafe context required) |
360369
| `AppendLine()` | Appends a line terminator |
361370
| `AppendLine(string)` | Appends a string followed by a line terminator |
362-
| `AppendIf(bool, string)` | Conditionally appends a string |
363-
| `AppendLineIf(bool, string)` | Conditionally appends a string with line terminator |
364-
| `AppendFormat(IFormatProvider, string, ...)` | Appends formatted string |
371+
| `AppendLine(bool)` | Appends a Boolean value followed by a line terminator |
372+
| `AppendLine(char)` | Appends a character followed by a line terminator |
373+
| `AppendLine(char, int)` | Appends a repeated character followed by a line terminator |
374+
| `AppendLine(char[])` | Appends a character array followed by a line terminator |
375+
| `AppendLine(char[], int, int)` | Appends a subset of character array followed by a line terminator |
376+
| `AppendLine(ReadOnlyMemory<char>)` | Appends read-only memory followed by a line terminator |
377+
| `AppendLine(ReadOnlyMemory<char>, int, int)` | Appends subset of read-only memory followed by a line terminator |
378+
| `AppendLine(char*, int)` | Appends unsafe pointer characters followed by a line terminator |
365379
| `Clear()` | Removes all content from the builder |
366380
| `EnsureCapacity(int)` | Ensures the builder has at least the specified capacity |
367381
| `ToString()` | Returns the built string |
@@ -374,12 +388,41 @@ public string GenerateInterface(string interfaceName, List<MethodSignature> meth
374388
| `Length` | `int` | Gets the current length of the content |
375389
| `UseTabs` | `bool` | Gets or sets whether to use tabs instead of spaces for indentation |
376390

377-
### Indentation Methods
391+
### Conditional Methods
392+
393+
| Method | Description |
394+
|--------|-------------|
395+
| `AppendIf(bool, string)` | Conditionally appends a string |
396+
| `AppendIf(bool, string, int, int)` | Conditionally appends a substring |
397+
| `AppendIf(bool, bool)` | Conditionally appends a Boolean value |
398+
| `AppendIf(bool, char)` | Conditionally appends a character |
399+
| `AppendIf(bool, char, int)` | Conditionally appends a repeated character |
400+
| `AppendIf(bool, char[])` | Conditionally appends a character array |
401+
| `AppendIf(bool, char[], int, int)` | Conditionally appends a subset of character array |
402+
| `AppendIf(bool, ReadOnlyMemory<char>)` | Conditionally appends read-only memory |
403+
| `AppendIf(bool, ReadOnlyMemory<char>, int, int)` | Conditionally appends subset of read-only memory |
404+
| `AppendIf(bool, char*, int)` | Conditionally appends unsafe pointer characters |
405+
| `AppendLineIf(bool)` | Conditionally appends a line terminator |
406+
| `AppendLineIf(bool, string)` | Conditionally appends a string with line terminator |
407+
| `AppendLineIf(bool, bool)` | Conditionally appends a Boolean value with line terminator |
408+
| `AppendLineIf(bool, char)` | Conditionally appends a character with line terminator |
409+
| `AppendLineIf(bool, char, int)` | Conditionally appends a repeated character with line terminator |
410+
| `AppendLineIf(bool, char[])` | Conditionally appends a character array with line terminator |
411+
| `AppendLineIf(bool, char[], int, int)` | Conditionally appends a subset of character array with line terminator |
412+
| `AppendLineIf(bool, ReadOnlyMemory<char>)` | Conditionally appends read-only memory with line terminator |
413+
| `AppendLineIf(bool, ReadOnlyMemory<char>, int, int)` | Conditionally appends subset of read-only memory with line terminator |
414+
| `AppendLineIf(bool, char*, int)` | Conditionally appends unsafe pointer characters with line terminator |
415+
416+
### Format Methods
378417

379418
| Method | Description |
380419
|--------|-------------|
381-
| `IncrementIndent()` | Increases indentation level by one |
382-
| `DecrementIndent()` | Decreases indentation level by one |
420+
| `AppendFormat(string, object)` | Appends formatted string with single argument |
421+
| `AppendFormat(string, params object[])` | Appends formatted string with multiple arguments |
422+
| `AppendFormat(IFormatProvider, string, object)` | Appends formatted string with single argument and format provider |
423+
| `AppendFormat(IFormatProvider, string, object, object)` | Appends formatted string with two arguments and format provider |
424+
| `AppendFormat(IFormatProvider, string, object, object, object)` | Appends formatted string with three arguments and format provider |
425+
| `AppendFormat(IFormatProvider, string, params object[])` | Appends formatted string with multiple arguments and format provider |
383426

384427
### XML Documentation Methods
385428

@@ -389,29 +432,25 @@ public string GenerateInterface(string interfaceName, List<MethodSignature> meth
389432
| `AppendXmlDocSummary(string)` | Appends an XML summary element |
390433
| `AppendXmlDocSummary(IEnumerable<string>)` | Appends an XML summary element with multiple lines |
391434
| `AppendXmlDocParam(string, string)` | Appends an XML param element |
435+
| `AppendXmlDocParams(IEnumerable<(string, string)>)` | Appends multiple XML param elements |
392436
| `AppendXmlDocReturns(string)` | Appends an XML returns element |
393437
| `AppendXmlDocException(string, string)` | Appends an XML exception element |
438+
| `AppendXmlDocExceptions(IEnumerable<(string, string)>)` | Appends multiple XML exception elements |
394439
| `AppendXmlDocRemarks(string)` | Appends an XML remarks element |
440+
| `AppendXmlDocRemarks(IEnumerable<string>)` | Appends an XML remarks element with multiple lines |
395441
| `AppendXmlDocExample(string)` | Appends an XML example element |
442+
| `AppendXmlDocExample(IEnumerable<string>)` | Appends an XML example element with multiple lines |
443+
| `AppendXmlDocValue(string)` | Appends an XML value element |
444+
| `AppendXmlDocTypeParam(string, string)` | Appends an XML typeparam element |
445+
| `AppendXmlDocTypeParams(IEnumerable<(string, string)>)` | Appends multiple XML typeparam elements |
446+
| `AppendXmlDocSee(string)` | Appends an XML see element |
447+
| `AppendXmlDocSeeAlso(string)` | Appends an XML seealso element |
448+
| `AppendXmlDocInheritDoc(string)` | Appends an XML inheritdoc element |
396449
| `AppendXmlDocCustomElement(string, string, string)` | Appends a custom XML documentation element |
397450

398-
### Format Methods
399-
400-
| Method | Description |
401-
|--------|-------------|
402-
| `AppendFormat(IFormatProvider, string, object)` | Appends formatted string with single argument |
403-
| `AppendFormat(IFormatProvider, string, object, object)` | Appends formatted string with two arguments |
404-
| `AppendFormat(IFormatProvider, string, object, object, object)` | Appends formatted string with three arguments |
405-
| `AppendFormat(IFormatProvider, string, params object[])` | Appends formatted string with multiple arguments |
406-
407-
### Memory-Efficient Methods
451+
### Indentation Methods
408452

409-
| Method | Description |
410-
|--------|-------------|
411-
| `Append(ReadOnlyMemory<char>)` | Appends read-only memory of characters |
412-
| `Append(ReadOnlyMemory<char>, int, int)` | Appends subset of read-only memory |
413-
| `Append(char*, int)` | Appends characters from unsafe pointer (unsafe context required) |
414-
| `Append(char[], int, int)` | Appends subset of character array |
453+
**Note**: Indentation is handled automatically when appending `{` `}` `[` `]` characters. Manual indentation control methods are internal to the library and not directly accessible.
415454

416455
## 🤝 Contributing
417456

0 commit comments

Comments
 (0)