MiJenner.ConsoleUtils/MiJenner.xml at main · mijenner/MiJenner.ConsoleUtils · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
<?xml version="1.0"?>
<doc>
    <assembly>
        <name>MiJenner</name>
    </assembly>
    <members>
        <member name="M:MiJenner.ConsoleUtils.OpenExplorerFinder">
            <summary>
            Opens the platform specific file explorer / finder with
            the directory set to where the compiled executable is placed.
            </summary>
            <exception cref="T:System.PlatformNotSupportedException"></exception>
        </member>
        <member name="M:MiJenner.ConsoleUtils.OpenExplorerFinderPath(System.String)">
            <summary>
            Open the platform specific file explorer / finder.
            <code>
            OpenExplorerFinderPath(".");
            </code>
            </summary>
            <param name="outputDir">Is path of the directory used.</param>
            <exception cref="T:System.PlatformNotSupportedException"></exception>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadInt(System.String,System.String)">
            <summary>
            Reads an integer from console.
            Continuously asks user until a valid integer is entered.
            </summary>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <returns>An integer</returns>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadDouble(System.String,System.String)">
            <summary>
            Reads a double from console.
            Continuously asks user until a valid double is entered.
            </summary>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <returns>Returns a double</returns>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadDecimal(System.String,System.String)">
            <summary>
            Reads a decimal from console.
            Continuously asks user until a valid decimal is entered.
            </summary>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <returns>Returns a decimal</returns>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadBoolean(System.String,System.String,System.String,System.String)">
            <summary>
            Reads a boolean from console.
            Continuously asks user until a valid boolean is entered.
            <code>
            Boolean myBool = ConsoleUtils.ReadBoolean("Please provide a boolean", "No, please provide a boolean", "t", "f");
            </code>
            </summary>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <param name="trueValue">Optional: e.g. t for true (default = j)</param>
            <param name="falseValue">Optional: e.g. f for false (default = n)</param>
            <returns>A boolean</returns>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadDate(System.String,System.String)">
            <summary>
            Reads a date from console.
            Continuously asks user until a valid date is entered.
            </summary>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <returns>Returns a date (DateTime object)</returns>
        </member>
        <member name="M:MiJenner.ConsoleUtils.ReadEnum``1(System.String,System.String)">
            <summary>
            Reads the textual representation of the provided enum from console, and converts it to an enum.
            Continuously asks user until a valid enum is entered.
            </summary>
            <typeparam name="T"></typeparam>
            <param name="prompt">Prompt to user (a space is appended by library)</param>
            <param name="errorMessage">Error message if user types a noncompliant value (a space is appended by library)</param>
            <returns>An enum of the specified type</returns>
        </member>
    </members>
</doc>