Skip to content

Commit

Permalink
Update api docs
Browse files Browse the repository at this point in the history
  • Loading branch information
calacayir committed Jul 19, 2024
1 parent 9eb794f commit ce91dcf
Show file tree
Hide file tree
Showing 223 changed files with 433 additions and 593 deletions.
27 changes: 14 additions & 13 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ Supports
[![Nuget](https://img.shields.io/nuget/v/DotMake.CommandLine?style=for-the-badge&logo=nuget)](https://www.nuget.org/packages/DotMake.CommandLine)

![DotMake Command-Line Intro](https://raw.githubusercontent.com/dotmake-build/command-line/master/images/intro.gif "DotMake Command-Line Intro")

![DotMake Command-Line Themes](https://raw.githubusercontent.com/dotmake-build/command-line/master/images/themes.gif "DotMake Command-Line Themes")

## Getting started
Expand Down Expand Up @@ -201,23 +202,23 @@ When you run the app via
- or `dotnet run -- -?` in project directory (e.g. in `TestApp`) (note the double hyphen/dash which allows `dotnet run` to pass arguments to our actual application)

- You see this usage help:
```console
DotMake Command-Line TestApp v1.6.0
Copyright © 2023-2024 DotMake
```console
DotMake Command-Line TestApp v1.6.0
Copyright © 2023-2024 DotMake

A root cli command
A root cli command

Usage:
TestApp <argument-1> [options]
Usage:
TestApp <argument-1> [options]

Arguments:
<argument-1> Description for Argument1 [required]
Arguments:
<argument-1> Description for Argument1 [required]

Options:
-o, --option-1 <option-1> Description for Option1 [default: DefaultForOption1]
-v, --version Show version information
-?, -h, --help Show help and usage information
```
Options:
-o, --option-1 <option-1> Description for Option1 [default: DefaultForOption1]
-v, --version Show version information
-?, -h, --help Show help and usage information
```
- First line comes from `AssemblyProductAttribute` or `AssemblyName` (`<Product>` tag in your .csproj file).
Version comes from `AssemblyInformationalVersionAttribute` or `AssemblyFileVersionAttribute` or `AssemblyVersionAttribute`
(`<InformationalVersion>` or `<FileVersion >` or `<Version>` tag in your .csproj file).
Expand Down
2 changes: 1 addition & 1 deletion docs/api/fti/FTI_100.json

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/api/fti/FTI_101.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"existingdirectory":[12779521,13041666],"expression":[3932161,4259841,7733252,8257540,8323076,10551300,11927556,12845060,13041667],"enablediagramdirective":[10027009,10747905,12976129],"existingfile":[12779521,13041666],"exist":[12779523],"examine":[4194305,4718593,12582913],"exceptions":[9306113,10747905,12582915,12976129],"enumerations":[6291458],"examples":[6291457,11927553,12779522],"element":[655361,4390914,12582913],"environment":[10747905,11468802,12976129],"easily":[12582913],"explicit":[6291457,12845057],"enumeration":[11272193,11862017,12648449,12779521],"enabled":[9568257,9633794,10747905,12976129],"enables":[9306113,9568257,10027009,10747910,11468801,11534337,12320769,12976134],"exe":[6291457,13041665],"ext":[6094849,10682370,12582915],"existingfileordirectory":[12779521,13041665],"easy":[7405569,7733249,8126465,8323073,9240577,9830401,11927553,12845057,13041666],"error":[3,3932161,4259841,6488070,7077889,7667713,7733250,8323074,8781830,8847361,9371649,9437185,10420229,10747909,11010049,11337734,11927554,12845058,12976133,13041667],"end":[655361,4390913,11993089,12124161,12255233,12582913],"env":[10747905,11468801,12976129],"enable":[9306113,9568257,10027009,11468801,12320769],"extra":[7602177,9240577,13041665],"expand":[9633793,10747905,12320769,12976129],"especially":[13041665],"example":[65537,2752513,4194306,4325378,4456450,4718594,4784130,4915202,5308418,5767170,6291463,7405569,7602177,7733250,8126465,8323075,8454145,8978433,9175041,9240579,9502721,9830401,10944513,11927557,11993090,12124161,12255234,12582915,12713985,12845064,13041679],"exit":[4325378,4456450,4784130,4915202,5308418,5767170,12582914],"enableenvironmentvariablesdirective":[10747905,11468801,12976129],"enum":[6684673,7077889,7733250,8323074,8847361,9109505,11272193,11862017,11927554,12648449,12779521,12845058],"extension":[3932162,3997698,4259842,4521986,4653058,4849666,5046274,5111810,5242882,5505026,5570562,5832706,6094850,6291461,6553602,10682370,11796482,12058625,12386305,12582916,12910593],"errors":[262148,655361,3932161,3997697,4194306,4259841,4390913,4718594,5046273,5963780,7602178,9240577,10420225,10747905,12386308,12582915,12976129,13041665],"empty":[393218,1441793,2424833,3735553,4521985,5570561,7733249,7929858,8323073,8454145,8978433,9240577,9502721,11927553,12845057,12910594,13041665,13107201],"enableposixbundling":[10747905,12320771,12976129],"entering":[6291457,13041665],"elements":[655361,1507329,2621441,2949121,4390913,12582913],"executable":[655361,4390913,6291458,12582913,13041666],"enumerable":[1507329,2621441,2949121,13041665],"enablesuggestdirective":[9568257,10747905,12976129],"exception":[9306116,10747907,12582918,12976131,13041676],"explaining":[10027009,10747905,12976129],"extended":[1769473,1900545,2228225,2293761,3735556,5373954,5701634,13107204],"explicitly":[6291457,11927553,12582913],"escape":[655361,4390913,12582913],"enumerableclicommand":[13041665],"enclosing":[5832705],"encoding":[10747905,11010049,12976129],"exactly":[12648449],"equivalent":[8323073,9895937,12320770,12845057],"exists":[12779523,13041665],"enabledefaultexceptionhandler":[9306113,10747905,12582913,12976129],"external":[1507330,1703937,2162690,2490370,2621442,3735557,5177346,5636098,5898241,8060929,8192001,9961474,13041667,13107207],"encoded":[6553601],"extensions":[262145,393217,917505,3932161,3997697,4259841,4521985,4653057,4849665,5046273,5111809,5242881,5505025,5570561,5832705,5963777,6094849,6291457,6553601,7929857,10682369,11796482,12058625,12386305,12582915,12910593],"enforced":[10747905,11534337,12976129],"escaped":[917506,5832706,12058626],"exactlyone":[7208961,7733249,7995393,8323073,11927553,12648449,12845057],"enclosed":[917505,5832705,12058625]}
{"existingdirectory":[12779521,13041666],"expression":[3866625,4063233,7471108,7798788,8454148,8781828,12320772,12845060,13041667],"enablediagramdirective":[6946817,11206657,12976129],"existingfile":[12779521,13041666],"exist":[12779523],"examine":[4325377,5373953,12451841],"exceptions":[6946817,10616833,12451843,12976129],"enumerations":[6881282],"examples":[6881281,12320769,12779522],"element":[851969,4784130,12451841],"environment":[6946817,9240578,12976129],"easily":[12451841],"explicit":[6881282,12845059],"enumeration":[11337729,12058625,12713985,12779521],"enabled":[6946817,10944513,11141122,12976129],"enables":[6946822,9240577,10092545,10551297,10616833,10944513,11206657,12976134],"exe":[6881281,13041665],"ext":[6160385,10420226,12451843],"existingfileordirectory":[12779521,13041665],"easy":[6488065,7471105,7798785,7995393,8716289,9109505,12320769,12845057,13041666],"error":[65539,3866625,4063233,6356998,6946821,7012353,7471106,7733249,7798786,7864326,8650753,9764865,10747905,11272198,11468805,11730945,12320770,12845058,12976133,13041667],"end":[851969,4784129,8519681,11993089,12255233,12451841],"env":[6946817,9240577,12976129],"enable":[9240577,10092545,10616833,10944513,11206657],"extra":[9109505,9633793,13041665],"expand":[6946817,10092545,11141121,12976129],"especially":[13041665],"example":[720897,2752513,4325378,4521986,4587522,5046274,5373954,5701634,5832706,6029314,6488065,6881288,7143425,7471106,7798787,7995393,8519682,8716289,8978433,9043969,9109507,9633793,9699329,10878977,11993089,12255234,12320773,12451843,12648449,12845066,13041679],"exit":[4521986,4587522,5046274,5701634,5832706,6029314,12451842],"enableenvironmentvariablesdirective":[6946817,9240577,12976129],"enum":[6422529,7012353,7471106,7798786,8126465,10747905,11337729,12058625,12320770,12713985,12779521,12845058],"extension":[3866626,4063234,4390914,4456450,4653058,4849666,4915202,4980738,5177346,5439490,5505026,5570562,5636098,6160386,6881285,10420226,11862018,12189697,12451844,12517377,12910593],"errors":[655364,851969,3866625,4063233,4325378,4390913,4456449,4784129,5373954,6291460,6946817,9109505,9633794,11468801,12451843,12517380,12976129,13041665],"empty":[589826,1376257,1572865,2949121,4980737,5636097,7143425,7471105,7798785,8060930,8978433,9043969,9109505,12320769,12845057,12910594,13041665,13107201],"enableposixbundling":[6946817,10092547,12976129],"entering":[6881281,13041665],"elements":[851969,1441793,1507329,2883585,4784129,12451841],"executable":[851969,4784129,6881282,12451841,13041666],"enumerable":[1441793,1507329,2883585,13041665],"enablesuggestdirective":[6946817,10944513,12976129],"exception":[6946819,10616836,12451846,12976131,13041676],"explaining":[6946817,11206657,12976129],"extended":[1376260,1703937,1835009,1900545,1966081,5308418,5963778,13107204],"explicitly":[6881281,12320769,12451841],"escape":[851969,4784129,12451841],"enumerableclicommand":[13041665],"enclosing":[5177345],"encoding":[6946817,9764865,12976129],"exactly":[12713985],"equivalent":[7798785,9175041,10092546,12845057],"exists":[12779523,13041665],"enabledefaultexceptionhandler":[6946817,10616833,12451841,12976129],"external":[1376261,1441794,1507330,1769474,2097154,2490369,5242882,5767169,6094850,7340033,7602177,9961474,13041667,13107207],"encoded":[4653057],"extensions":[524289,589825,655361,3866625,4063233,4390913,4456449,4653057,4849665,4915201,4980737,5177345,5439489,5505025,5570561,5636097,6160385,6291457,6881281,8060929,10420225,11862018,12189697,12451843,12517377,12910593],"enforced":[6946817,10551297,12976129],"escaped":[524290,5177346,12189698],"exactlyone":[7077889,7471105,7798785,9895937,12320769,12713985,12845057],"enclosed":[524289,5177345,12189697]}
2 changes: 1 addition & 1 deletion docs/api/fti/FTI_102.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"formats":[6291457,12517377],"false":[7077889,7733249,8323073,8847361,11927553,12845057,13041685],"func":[786434,1572869,1835016,2949123,3735555,7340035,13107203],"following":[655361,4390913,6291458,8323074,9895938,11927553,12320770,12582913,12845059],"forced":[7077891,7733251,8323075,8847363,11927555,12845059],"forms":[7012353,7536641,9240578,13041666],"fileinfo":[13041667],"form":[7012354,7536642,7798786,8650754,9240578,9961474,11862018,13041666,13107202],"framework":[7077889,7733249,8323073,8847361,11927553,12845057],"fullname":[11927553,12582914,12845057,13041665],"formatting":[6291458,10354689,10747905,11993089,12713985,12976129],"facilities":[10747905,11010049,12976129],"fails":[3932161,4259841,7667713,7733249,8323073,9371649,11927553,12845057],"forwardslash":[11862017,13041670],"fail":[7602177,9240577,13041665],"fall":[1769473,1900545,2228225,2293761,3735556,5373954,5701634,13107204],"files":[6815745,9240577,9633794,10747905,12976129,13041665],"file":[655361,4390913,7077889,7733249,8323073,8847361,9633794,10747905,11927553,12582913,12779528,12845057,12976129],"follow":[131073],"filename":[12779521],"fields":[524291,13107202],"followed":[7012353,7536641,9240578,13041666],"firstcolumncolor":[11730945,11993089,12255233],"feature":[6094849,6291457,7405569,7733249,8126465,8323073,9240577,9830401,10682369,11796481,11927553,12582913,12845057,13041665],"follows":[6291457,12845057],"forward":[11862017,13041665],"flagsattribute":[12779521],"field":[786434],"first":[65539,655361,2686977,2752513,3473409,3932161,3997697,4259841,4390913,4521985,4653057,4849665,5046273,5111809,5242881,5505025,5570561,5832705,6553601,11272196,11730947,11993090,12255234,12582913,12713987,13041665],"ftp":[12779522],"foreach":[13041665],"features":[7405569,7733249,8126465,8323073,9240577,9830401,11927553,12845057,13041665],"fileaccess":[13041665]}
{"false":[7012353,7471105,7798785,10747905,12320769,12845057,13041685],"formats":[6881281,12386305],"func":[917506,1376259,1638405,2883587,3080200,5898243,13107203],"following":[851969,4784129,6881282,7798786,9175042,10092546,12320769,12451841,12845059],"forced":[7012355,7471107,7798787,10747907,12320771,12845059],"forms":[8257537,8847361,9109506,13041666],"fileinfo":[13041667],"form":[8192002,8257538,8847362,8912898,9109506,9961474,12058626,13041666,13107202],"framework":[7012353,7471105,7798785,10747905,12320769,12845057],"fullname":[12320769,12451842,12845057,13041665],"formatting":[6881282,6946817,11796481,12255233,12648449,12976129],"facilities":[6946817,9764865,12976129],"fails":[3866625,4063233,7471105,7733249,7798785,11730945,12320769,12845057],"forwardslash":[12058625,13041670],"fail":[9109505,9633793,13041665],"fall":[1376260,1703937,1835009,1900545,1966081,5308418,5963778,13107204],"files":[6946817,7405569,9109505,11141122,12976129,13041665],"file":[851969,4784129,6946817,7012353,7471105,7798785,10747905,11141122,12320769,12451841,12779528,12845057,12976129],"follow":[1],"filename":[12779521],"fields":[262147,13107202],"followed":[8257537,8847361,9109506,13041666],"firstcolumncolor":[8519681,11927553,12255233],"feature":[6160385,6488065,6881281,7471105,7798785,7995393,8716289,9109505,10420225,11862017,12320769,12451841,12845057,13041665],"follows":[6881281,12845057],"forward":[12058625,13041665],"flagsattribute":[12779521],"field":[917506],"first":[720899,851969,2555905,2752513,3407873,3866625,4063233,4390913,4456449,4653057,4784129,4849665,4915201,4980737,5177345,5439489,5505025,5570561,5636097,8519682,11337732,11927555,12255234,12451841,12648451,13041665],"ftp":[12779522],"foreach":[13041665],"features":[6488065,7471105,7798785,7995393,8716289,9109505,12320769,12845057,13041665],"fileaccess":[13041665]}
2 changes: 1 addition & 1 deletion docs/api/fti/FTI_103.json
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"getargumentparser":[1572866,1835010,3735554,7340034,13107202],"getargumentdescription":[65537,3145729,12713985],"generator":[524289,786433,4063233,4194305,4456449,4521985,4587521,4718593,4784129,4915201,5570561,5767169,6094849,6291459,7077889,7733249,8323073,8847361,10682369,11796481,11927553,12451841,12582914,12845057,13041665,13107202],"gray":[11206657,11993089,12255233],"getlayout":[458753,2949121,12517377],"getdefaultvalue":[1769473,1900545,2228225,2293761,3735556,5373954,5701634,13107204],"global":[6291459,11927555,12845060],"general":[2],"generic":[13041666],"getargs":[655361,4390913,4718593,4784129,5767169,12582913],"getting":[12845057],"google":[12779525],"getargumentdefaultvalue":[65537,2555905,12713985],"generated":[4063233,4194305,4456449,4521985,4587521,4718593,4784129,4915201,5570561,5767169,6094849,6291459,6946817,7012353,7471105,7536641,7798785,8060929,8650753,8716289,9240580,9764865,9961478,10485761,10682369,11796481,12451841,12582913,13041669,13107207],"getconfiguration":[655362,4063234,4587522,6356994,12582914],"guide":[3932161,3997697,4259841,4521985,4653057,4849665,5046273,5111809,5242881,5505025,5570561,5832705,6553601],"getargumentusagelabel":[65537,2752513,12713985],"gettwocolumnrow":[458753,3604481,12517377],"getvalueforargument":[1769474,1900546,3735554,5701634,13107202],"green":[9699330,10158083,11993091,12255235],"getvalueforoption":[2228226,2293762,3735554,5373954,13107202],"grammar":[4063234,4194305,4325377,4456449,4587522,4718593,4784129,4915201,5308417,5767169],"group":[6291458,13041667],"getcommandusagelabel":[65537,2686977,12713985],"getcommandlineargs":[655361,4390913,12582913],"getchildren":[1507330,2621442,3735554,5177346,13107202],"getoptionusagelabel":[65537,3473409,12713985],"generate":[7536641,7733249,8323073,8454145,8650753,8978433,9240577,9502721,11927553,12582913,12845057,13041665],"gettype":[11927553,12582914,12845057,13041665],"gets":[65541,458754,655362,720897,851969,917507,983041,1376257,1507329,1572865,1638401,1769473,1835009,1900545,2228225,2293761,2424833,2555905,2621441,2686977,2752513,2949121,3145729,3473409,3604481,3735562,4063233,4587521,4653057,4980738,5177346,5373954,5701634,5832705,6356994,6422529,6488068,6553601,6684673,6750209,6815745,6881281,6946817,7012353,7077889,7208961,7274497,7340034,7405569,7471105,7536641,7602177,7667713,7733258,7798785,7864321,7995393,8126465,8192001,8257537,8323085,8388609,8454145,8519681,8585217,8650753,8781825,8847361,8912897,8978433,9043969,9109505,9175041,9240586,9371649,9437185,9502721,9633793,9699329,9764865,9830401,9895937,9961477,10092545,10158081,10223617,10289153,10354689,10420225,10485761,10551297,10616833,10747908,10813441,10878977,10944513,11010049,11075585,11206657,11337733,11403265,11599873,11665409,11730945,11927564,11993104,12058627,12124161,12189697,12255248,12451841,12517378,12582914,12713989,12845071,12976132,13041674,13107215]}
{"getargumentparser":[1376258,1638402,3080194,5898242,13107202],"getargumentdescription":[720897,3473409,12648449],"generator":[262145,917505,4259841,4325377,4521985,4718593,4980737,5046273,5373953,5636097,5701633,6029313,6160385,6881283,7012353,7471105,7798785,10420225,10747905,11862017,12320769,12451842,12582913,12845057,13041665,13107202],"gray":[8519681,11403265,12255233],"getlayout":[1048577,2883585,12386305],"getdefaultvalue":[1376260,1703937,1835009,1900545,1966081,5308418,5963778,13107204],"global":[6881283,12320771,12845060],"general":[65538],"generic":[13041666],"getargs":[851969,4784129,5373953,5701633,6029313,12451841],"getting":[12845057],"google":[12779525],"getargumentdefaultvalue":[720897,2686977,12648449],"generated":[4259841,4325377,4521985,4718593,4980737,5046273,5373953,5636097,5701633,6029313,6160385,6750209,6881283,7536641,7602177,7929857,8192001,8257537,8585217,8847361,8912897,9109508,9437185,9961478,10420225,11862017,12451841,12582913,13041669,13107207],"getconfiguration":[851970,4259842,4718594,6815746,12451842],"guide":[3866625,4063233,4390913,4456449,4653057,4849665,4915201,4980737,5177345,5439489,5505025,5570561,5636097],"getargumentusagelabel":[720897,2752513,12648449],"gettwocolumnrow":[1048577,3735553,12386305],"getvalueforargument":[1376258,1703938,1966082,5963778,13107202],"green":[8519683,10158083,10813442,12255235],"getvalueforoption":[1376258,1835010,1900546,5308418,13107202],"grammar":[4259842,4325377,4521985,4587521,4718594,5046273,5373953,5701633,5832705,6029313],"group":[6881282,13041667],"getcommandusagelabel":[720897,3407873,12648449],"getcommandlineargs":[851969,4784129,12451841],"getchildren":[1376258,1441794,1507330,5242882,13107202],"getoptionusagelabel":[720897,2555905,12648449],"generate":[7143425,7471105,7798785,8192001,8257537,8978433,9043969,9109505,12320769,12451841,12845057,13041665],"gettype":[12320769,12451842,12845057,13041665],"gets":[327681,393217,524291,720901,851970,983041,1048578,1310721,1376266,1441793,1507329,1638401,1703937,1835009,1900545,1966081,2031617,2555905,2686977,2752513,2883585,2949121,3080193,3407873,3473409,3735553,4259841,4653057,4718593,5111810,5177345,5242882,5308418,5570561,5898242,5963778,6356996,6422529,6488065,6619137,6750209,6815746,6946820,7012353,7077889,7143425,7208961,7340033,7471114,7405569,7536641,7667713,7733249,7798797,7864321,7995393,8126465,8192001,8257537,8323073,8388609,8454145,8519696,8585217,8650753,8781825,8716289,8847361,8912897,8978433,9043969,9109514,9175041,9306113,9371649,9437185,9502721,9568257,9633793,9699329,9764865,9830401,9895937,9961477,10027009,10158081,10223617,10289153,10354689,10485761,10682369,10747905,10813441,10878977,11010049,11141121,11272197,11403265,11468801,11534337,11599873,11665409,11730945,11796481,11927553,11993089,12124161,12189699,12255248,12320780,12386306,12451842,12582913,12648453,12845071,12976132,13041674,13107215]}
Loading

0 comments on commit ce91dcf

Please sign in to comment.