Skip to content

Commit 59797df

Browse files
author
Chris Crutchfield
committed
generate docs
1 parent 1c950f7 commit 59797df

File tree

95 files changed

+1987
-0
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

95 files changed

+1987
-0
lines changed

‎doc/Nerdbank/GitVersioning/CloudBuild.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# CloudBuild Class
2+
> Provides access to cloud build providers.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Inheritance Hierarchy
8+
        System.Object
9+
10+
                Nerdbank.GitVersioning.CloudBuild
11+
12+
## Syntax
13+
~~~~csharp
14+
public static class CloudBuild
15+
~~~~
16+
## Properties
17+
|Name|Description|
18+
|---|---|
19+
|[Active](/doc/Nerdbank/GitVersioning/CloudBuild/Properties/Active.md)|Gets the cloud build provider that applies to this build, if any.|
20+
## Fields
21+
|Name|Description|
22+
|---|---|
23+
|[SupportedCloudBuilds](/doc/Nerdbank/GitVersioning/CloudBuild/Fields/SupportedCloudBuilds.md)|An array of cloud build systems we support.|

‎doc/Nerdbank/GitVersioning/CloudBuild/Fields/SupportedCloudBuilds.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
# CloudBuild.SupportedCloudBuilds Field
2+
> An array of cloud build systems we support.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static readonly Nerdbank.GitVersioning.ICloudBuild[] SupportedCloudBuilds;
10+
~~~~

‎doc/Nerdbank/GitVersioning/CloudBuild/Properties/Active.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
# CloudBuild.Active Property
2+
> Gets the cloud build provider that applies to this build, if any.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static Nerdbank.GitVersioning.ICloudBuild Active
10+
{
11+
get;
12+
}
13+
~~~~

‎doc/Nerdbank/GitVersioning/GitExtensions.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# GitExtensions Class
2+
> Git extension methods.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Inheritance Hierarchy
8+
        System.Object
9+
10+
                Nerdbank.GitVersioning.GitExtensions
11+
12+
## Syntax
13+
~~~~csharp
14+
public static class GitExtensions
15+
~~~~
16+
## Methods
17+
|Name|Description|
18+
|---|---|
19+
|[GetVersionHeight(Commit, String, Version)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Commit%2c%20String%2c%20Version_.md)|Gets the number of commits in the longest single path between
20+
the specified commit and the most distant ancestor (inclusive)
21+
that set the version to the value at .|
22+
|[GetVersionHeight(Repository, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Repository%2c%20String_.md)|Gets the number of commits in the longest single path between
23+
HEAD in a repo and the most distant ancestor (inclusive)
24+
that set the version to the value in the working copy
25+
(or HEAD for bare repositories).|
26+
|[GetVersionHeight(Branch, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetVersionHeight_Branch%2c%20String_.md)|Gets the number of commits in the longest single path between
27+
the specified commit and the most distant ancestor (inclusive)
28+
that set the version to the value at the tip of the .|
29+
|[GetTruncatedCommitIdAsInt32(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsInt32_Commit_.md)|Takes the first 4 bytes of a commit ID (i.e. first 8 characters of its hex-encoded SHA)
30+
and returns them as an integer.|
31+
|[GetTruncatedCommitIdAsUInt16(Commit)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsUInt16_Commit_.md)|Takes the first 2 bytes of a commit ID (i.e. first 4 characters of its hex-encoded SHA)
32+
and returns them as an 16-bit unsigned integer.|
33+
|[GetCommitFromTruncatedIdInteger(Repository, Int32)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromTruncatedIdInteger_Repository%2c%20Int32_.md)|Looks up a commit by an integer that captures the first for bytes of its ID.|
34+
|[GetCommitFromVersion(Repository, Version, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromVersion_Repository%2c%20Version%2c%20String_.md)|Looks up the commit that matches a specified version number.|
35+
|[GetCommitsFromVersion(Repository, Version, String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitsFromVersion_Repository%2c%20Version%2c%20String_.md)|Looks up the commits that match a specified version number.|
36+
|[FindLibGit2NativeBinaries(String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/FindLibGit2NativeBinaries_String_.md)|Finds the directory that contains the appropriate native libgit2 module.|
37+
|[OpenGitRepo(String)](/doc/Nerdbank/GitVersioning/GitExtensions/Methods/OpenGitRepo_String_.md)|Opens a found at or above a specified path.|

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/FindLibGit2NativeBinaries_String_.md‎

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# GitExtensions.FindLibGit2NativeBinaries(String) Method
2+
> Finds the directory that contains the appropriate native libgit2 module.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static string FindLibGit2NativeBinaries(string basePath);
10+
~~~~
11+
##### Parameters
12+
*basePath*
13+
14+
            Type: String
15+
16+
            The path to the directory that contains the lib folder.
17+
18+
19+
##### Return Value
20+
Type: String
21+
22+
Receives the directory that native binaries are expected.
23+

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromTruncatedIdInteger_Repository, Int32_.md‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
# GitExtensions.GetCommitFromTruncatedIdInteger(Repository, Int32) Method
2+
> Looks up a commit by an integer that captures the first for bytes of its ID.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static Commit GetCommitFromTruncatedIdInteger(this Repository repo, int truncatedId);
10+
~~~~
11+
##### Parameters
12+
*repo*
13+
14+
            Type: Repository
15+
16+
            The repo to search for a matching commit.
17+
18+
19+
*truncatedId*
20+
21+
            Type: Int32
22+
23+
            The value returned from .
24+
25+
26+
##### Return Value
27+
Type: Commit
28+
29+
A matching commit.
30+

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitFromVersion_Repository, Version, String_.md‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# GitExtensions.GetCommitFromVersion(Repository, Version, String) Method
2+
> Looks up the commit that matches a specified version number.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static Commit GetCommitFromVersion(this Repository repo, System.Version version, string repoRelativeProjectDirectory = null);
10+
~~~~
11+
##### Parameters
12+
*repo*
13+
14+
            Type: Repository
15+
16+
            The repository to search for a matching commit.
17+
18+
19+
*version*
20+
21+
            Type: Version
22+
23+
            The version previously obtained from .
24+
25+
26+
*repoRelativeProjectDirectory*
27+
28+
            Type: String
29+
30+
            
31+
The repo-relative project directory from which was originally calculated.
32+
33+
34+
35+
##### Return Value
36+
Type: Commit
37+
38+
The matching commit, or null if no match is found.
39+

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetCommitsFromVersion_Repository, Version, String_.md‎

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# GitExtensions.GetCommitsFromVersion(Repository, Version, String) Method
2+
> Looks up the commits that match a specified version number.
3+
4+
**Namespace:** Nerdbank.GitVersioning
5+
6+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
7+
## Syntax
8+
~~~~csharp
9+
public static System.Collections.Generic.IEnumerable<Commit> GetCommitsFromVersion(this Repository repo, System.Version version, string repoRelativeProjectDirectory = null);
10+
~~~~
11+
##### Parameters
12+
*repo*
13+
14+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type: Repository
15+
16+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The repository to search for a matching commit.
17+
18+
19+
*version*
20+
21+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type: Version
22+
23+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The version previously obtained from .
24+
25+
26+
*repoRelativeProjectDirectory*
27+
28+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type: String
29+
30+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The repo-relative project directory from which was originally calculated.
31+
32+
33+
##### Return Value
34+
Type: IEnumerable`1
35+
36+
The matching commits, or an empty enumeration if no match is found.
37+

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsInt32_Commit_.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# GitExtensions.GetTruncatedCommitIdAsInt32(Commit) Method
2+
> Takes the first 4 bytes of a commit ID (i.e. first 8 characters of its hex-encoded SHA)
3+
and returns them as an integer.
4+
5+
**Namespace:** Nerdbank.GitVersioning
6+
7+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
8+
## Syntax
9+
~~~~csharp
10+
public static int GetTruncatedCommitIdAsInt32(this Commit commit);
11+
~~~~
12+
##### Parameters
13+
*commit*
14+
15+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type: Commit
16+
17+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The commit to identify with an integer.
18+
19+
20+
##### Return Value
21+
Type: Int32
22+
23+
The integer which identifies a commit.
24+

‎doc/Nerdbank/GitVersioning/GitExtensions/Methods/GetTruncatedCommitIdAsUInt16_Commit_.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# GitExtensions.GetTruncatedCommitIdAsUInt16(Commit) Method
2+
> Takes the first 2 bytes of a commit ID (i.e. first 4 characters of its hex-encoded SHA)
3+
and returns them as an 16-bit unsigned integer.
4+
5+
**Namespace:** Nerdbank.GitVersioning
6+
7+
**Assembly:** NerdBank.GitVersioning (in NerdBank.GitVersioning.dll)
8+
## Syntax
9+
~~~~csharp
10+
public static ushort GetTruncatedCommitIdAsUInt16(this Commit commit);
11+
~~~~
12+
##### Parameters
13+
*commit*
14+
15+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;Type: Commit
16+
17+
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The commit to identify with an integer.
18+
19+
20+
##### Return Value
21+
Type: UInt16
22+
23+
The unsigned integer which identifies a commit.
24+

0 commit comments

Comments
 (0)