This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

ApiSourceLocation Pennington.ApiMetadata

Source-link target for a documented type or member, typically used to render "view source" links.

Properties

Branch string?
Default: null
Branch or tag the path resolves against, or null when unknown.
EndLine int
Default: 0
1-based line number where the declaration ends.
Path string
Relative path to the source file within the repository.
RepoUrl string?
Default: null
Base URL of the source repository (e.g. GitHub URL), or null when unknown.
StartLine int
Default: 0
1-based line number where the declaration begins.

Constructors

.ctor

#
public sealed record ApiSourceLocation(
    string Path,
    int StartLine,
    int EndLine,
    string? RepoUrl,
    string? Branch);

Source-link target for a documented type or member, typically used to render "view source" links.

Parameters

Path string
Relative path to the source file within the repository.
StartLine int
1-based line number where the declaration begins.
EndLine int
1-based line number where the declaration ends.
RepoUrl string?
Base URL of the source repository (e.g. GitHub URL), or null when unknown.
Branch string?
Branch or tag the path resolves against, or null when unknown.

Pennington.ApiMetadata.ApiSourceLocation

namespace Pennington.ApiMetadata;

/// Source-link target for a documented type or member, typically used to render "view source" links.
public record ApiSourceLocation
{
    /// Source-link target for a documented type or member, typically used to render "view source" links.
    
public sealed record ApiSourceLocation(
    string Path,
    int StartLine,
    int EndLine,
    string? RepoUrl,
    string? Branch);


    /// Branch or tag the path resolves against, or null when unknown.
    
string? Branch
;

    /// 1-based line number where the declaration ends.
    
int EndLine
;

    /// Relative path to the source file within the repository.
    
string Path
;

    /// Base URL of the source repository (e.g. GitHub URL), or null when unknown.
    
string? RepoUrl
;

    /// 1-based line number where the declaration begins.
    
int StartLine
;
}