Skip to content

Commit 43ac9ac

Browse files
committed
📝 Update sdk documentation #109
1 parent 9b8474c commit 43ac9ac

File tree

2 files changed

+52
-26
lines changed

2 files changed

+52
-26
lines changed

sdk-docs/Xecrets.Sdk.Abstractions.md

Lines changed: 37 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -384,30 +384,6 @@ The version of the command line tool API to check.
384384
[System.Boolean](https://docs.microsoft.com/en-us/dotnet/api/System.Boolean 'System.Boolean')
385385
True if this SDK can work with the provided command line tool.
386386

387-
<a name='Xecrets.Sdk.Abstractions.IXfApi.StartMe(string)'></a>
388-
389-
## IXfApi.StartMe(string) Method
390-
391-
Get the start arguments necessary to start the program identified as [fileNameWithoutExtension](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi.StartMe(string).fileNameWithoutExtension 'Xecrets.Sdk.Abstractions.IXfApi.StartMe(string).fileNameWithoutExtension'), assuming that if we're started with "dotnet", this program should also be
392-
started with "dotnet" [fileNameWithoutExtension](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi.StartMe(string).fileNameWithoutExtension 'Xecrets.Sdk.Abstractions.IXfApi.StartMe(string).fileNameWithoutExtension').dll, otherwise it's an executable with
393-
".exe" or without depending on the current operating system.
394-
395-
```csharp
396-
string[] StartMe(string fileNameWithoutExtension);
397-
```
398-
#### Parameters
399-
400-
<a name='Xecrets.Sdk.Abstractions.IXfApi.StartMe(string).fileNameWithoutExtension'></a>
401-
402-
`fileNameWithoutExtension` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
403-
404-
#### Returns
405-
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
406-
407-
#### Exceptions
408-
409-
[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException')
410-
411387
<a name='Xecrets.Sdk.Abstractions.IXfApi.UpdatePrivateKeysAsync(Xecrets.Sdk.Models.XfCredentials,string)'></a>
412388

413389
## IXfApi.UpdatePrivateKeysAsync(XfCredentials, string) Method
@@ -500,4 +476,40 @@ Override the global debug cli flag if non-null.
500476
A [System.Threading.CancellationToken](https://docs.microsoft.com/en-us/dotnet/api/System.Threading.CancellationToken 'System.Threading.CancellationToken') to cancel any long running operation.
501477

502478
#### Returns
503-
[IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi')
479+
[IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfApi 'Xecrets.Sdk.Abstractions.IXfApi')
480+
An IXfApi instance.
481+
482+
<a name='Xecrets.Sdk.Abstractions.IXfStart'></a>
483+
484+
## IXfStart Interface
485+
486+
Provides start-up information for the application.
487+
488+
```csharp
489+
public interface IXfStart
490+
```
491+
### Methods
492+
493+
<a name='Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string)'></a>
494+
495+
## IXfStart.StartArgs(string) Method
496+
497+
Get the start arguments necessary to start the program identified as [fileNameWithoutExtension](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string).fileNameWithoutExtension 'Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string).fileNameWithoutExtension'), assuming that if we're started with "dotnet", this program should also be
498+
started with "dotnet" [fileNameWithoutExtension](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string).fileNameWithoutExtension 'Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string).fileNameWithoutExtension').dll, otherwise it's an executable with
499+
".exe" or without depending on the current operating system.
500+
501+
```csharp
502+
string[] StartArgs(string fileNameWithoutExtension);
503+
```
504+
#### Parameters
505+
506+
<a name='Xecrets.Sdk.Abstractions.IXfStart.StartArgs(string).fileNameWithoutExtension'></a>
507+
508+
`fileNameWithoutExtension` [System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')
509+
510+
#### Returns
511+
[System.String](https://docs.microsoft.com/en-us/dotnet/api/System.String 'System.String')[[]](https://docs.microsoft.com/en-us/dotnet/api/System.Array 'System.Array')
512+
513+
#### Exceptions
514+
515+
[System.InvalidOperationException](https://docs.microsoft.com/en-us/dotnet/api/System.InvalidOperationException 'System.InvalidOperationException')

sdk-docs/Xecrets.Sdk.XfApiFactory.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -112,4 +112,18 @@ An instance of [IXfApi](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXf
112112

113113
### Remarks
114114
Should normally not be used when using Axantum ready built command line tool binaries, as no license is
115-
provided. Another option to provide the license is to place it in a text file next to the executable.
115+
provided. Another option to provide the license is to place it in a text file next to the executable.
116+
117+
<a name='Xecrets.Sdk.XfApiFactory.Start()'></a>
118+
119+
## XfApiFactory.Start() Method
120+
121+
Create an [IXfStart](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfStart 'Xecrets.Sdk.Abstractions.IXfStart') instance providing startup information for the application.
122+
123+
```csharp
124+
public static Xecrets.Sdk.Abstractions.IXfStart Start();
125+
```
126+
127+
#### Returns
128+
[IXfStart](Xecrets.Sdk.Abstractions.md#Xecrets.Sdk.Abstractions.IXfStart 'Xecrets.Sdk.Abstractions.IXfStart')
129+
An IStart instance.

0 commit comments

Comments
 (0)