Added missing XML comments

pull/10/head
David Hall 2018-07-31 07:10:20 -06:00
parent 584fffed33
commit 4ff39de15f
7 changed files with 29 additions and 4 deletions

View File

@ -117,8 +117,7 @@ namespace Vanara
/// <param name="format">A format string containing formatting specifications.</param>
/// <param name="arg">An object to format.</param>
/// <returns>
/// The string representation of the value of <paramref name="arg"/>, formatted as specified by <paramref name="format"/> and
/// <paramref name="formatProvider"/>.
/// The string representation of the value of <paramref name="arg"/>, formatted as specified by <paramref name="format"/>.
/// </returns>
protected string HandleOtherFormats(string format, object arg) => (arg as IFormattable)?.ToString(format, Culture) ?? (arg?.ToString() ?? string.Empty);
}

View File

@ -10,6 +10,7 @@ namespace Vanara.PInvoke
/// <summary>Platform invokable enumerated types, constants and functions from aclui.h</summary>
public static partial class AclUI
{
/// <summary>Specifies the security descriptor to use.</summary>
public enum SECURITY_OBJECT_ID
{
/// <summary>

View File

@ -445,25 +445,40 @@ namespace Vanara.PInvoke
}
/// <summary>The BITS_COST_STATE enumeration defines the constant values that specify the BITS cost state.</summary>
// https://msdn.microsoft.com/en-us/library/windows/desktop/mt595901(v=vs.85).aspx
[PInvokeData("Bits5_0.h", MSDNShortId = "mt595901")]
// https://docs.microsoft.com/en-us/windows/desktop/Bits/bits-cost-state
[PInvokeData("Bits5_0.h", MSDNShortId = "A8C36D4E-98B3-45C4-9ECD-9B5280133176")]
[Flags]
public enum BITS_COST_STATE : uint
{
/// <summary>Unrestricted.</summary>
BITS_COST_STATE_UNRESTRICTED = 0x1,
/// <summary>Capped usage unknown.</summary>
BITS_COST_STATE_CAPPED_USAGE_UNKNOWN = 0x2,
/// <summary>Below cap.</summary>
BITS_COST_STATE_BELOW_CAP = 0x4,
/// <summary>Near cap.</summary>
BITS_COST_STATE_NEAR_CAP = 0x8,
/// <summary>Overcap charged.</summary>
BITS_COST_STATE_OVERCAP_CHARGED = 0x10,
/// <summary>Overcap throttled.</summary>
BITS_COST_STATE_OVERCAP_THROTTLED = 0x20,
/// <summary>Usage-based.</summary>
BITS_COST_STATE_USAGE_BASED = 0x40,
/// <summary>Roaming</summary>
BITS_COST_STATE_ROAMING = 0x80,
/// <summary>Ignore congestion.</summary>
BITS_COST_OPTION_IGNORE_CONGESTION = 0x80000000,
/// <summary>Reserved.</summary>
BITS_COST_STATE_RESERVED = 0x40000000,
/// <summary>Transfer not roaming.</summary>
BITS_COST_STATE_TRANSFER_NOT_ROAMING = (BITS_COST_OPTION_IGNORE_CONGESTION | BITS_COST_STATE_USAGE_BASED | BITS_COST_STATE_OVERCAP_THROTTLED | BITS_COST_STATE_OVERCAP_CHARGED | BITS_COST_STATE_NEAR_CAP | BITS_COST_STATE_BELOW_CAP | BITS_COST_STATE_CAPPED_USAGE_UNKNOWN | BITS_COST_STATE_UNRESTRICTED),
/// <summary>Transfer no surcharge.</summary>
BITS_COST_STATE_TRANSFER_NO_SURCHARGE = (BITS_COST_OPTION_IGNORE_CONGESTION | BITS_COST_STATE_USAGE_BASED | BITS_COST_STATE_OVERCAP_THROTTLED | BITS_COST_STATE_NEAR_CAP | BITS_COST_STATE_BELOW_CAP | BITS_COST_STATE_CAPPED_USAGE_UNKNOWN | BITS_COST_STATE_UNRESTRICTED),
/// <summary>Transfer standard.</summary>
BITS_COST_STATE_TRANSFER_STANDARD = (BITS_COST_OPTION_IGNORE_CONGESTION | BITS_COST_STATE_USAGE_BASED | BITS_COST_STATE_OVERCAP_THROTTLED | BITS_COST_STATE_BELOW_CAP | BITS_COST_STATE_CAPPED_USAGE_UNKNOWN | BITS_COST_STATE_UNRESTRICTED),
/// <summary>Transfer unrestricted.</summary>
BITS_COST_STATE_TRANSFER_UNRESTRICTED = (BITS_COST_OPTION_IGNORE_CONGESTION | BITS_COST_STATE_OVERCAP_THROTTLED | BITS_COST_STATE_UNRESTRICTED),
/// <summary>Transfer always.</summary>
BITS_COST_STATE_TRANSFER_ALWAYS = (BITS_COST_OPTION_IGNORE_CONGESTION | BITS_COST_STATE_ROAMING | BITS_COST_STATE_USAGE_BASED | BITS_COST_STATE_OVERCAP_THROTTLED | BITS_COST_STATE_OVERCAP_CHARGED | BITS_COST_STATE_NEAR_CAP | BITS_COST_STATE_BELOW_CAP | BITS_COST_STATE_CAPPED_USAGE_UNKNOWN | BITS_COST_STATE_UNRESTRICTED),
}

View File

@ -10,12 +10,19 @@ namespace Vanara.PInvoke
{
public static partial class CredUI
{
/// <summary>The maximum domain target name length.</summary>
public const int CRED_MAX_DOMAIN_TARGET_NAME_LENGTH = 256 + 1 + 80;
/// <summary>The maximum username length</summary>
public const int CRED_MAX_USERNAME_LENGTH = (256 + 1 + 256);
/// <summary>The maximum caption length</summary>
public const int CREDUI_MAX_CAPTION_LENGTH = 128;
/// <summary>The maximum domain target length</summary>
public const int CREDUI_MAX_DOMAIN_TARGET_LENGTH = CREDUI_MAX_USERNAME_LENGTH;
/// <summary>The maximum message length</summary>
public const int CREDUI_MAX_MESSAGE_LENGTH = 32767;
/// <summary>The maximum password length</summary>
public const int CREDUI_MAX_PASSWORD_LENGTH = (512 / 2);
/// <summary>The maximum username length</summary>
public const int CREDUI_MAX_USERNAME_LENGTH = CRED_MAX_USERNAME_LENGTH;
/// <summary>Options for the display of the <see cref="CredUIPromptForCredentials"/> and its functionality.</summary>

View File

@ -6,6 +6,7 @@ using Vanara.InteropServices;
namespace Vanara.PInvoke
{
/// <summary>Encapsulates classes exposed by DWNAPI.DLL</summary>
public static partial class DwmApi
{
/// <summary>Flags used by the DWM_BLURBEHIND structure to indicate which of its members contain valid information.</summary>

View File

@ -7,6 +7,7 @@ using Vanara.InteropServices;
namespace Vanara.PInvoke
{
/// <summary>Exposes interfaces for Task Scheduler 1.0.</summary>
public static class MSTask
{
/// <summary>Valid types of triggers</summary>

View File

@ -10,6 +10,7 @@ using Vanara.InteropServices;
namespace Vanara.PInvoke
{
/// <summary>Exposes methods and interfaces for Task Scheduler 2.0.</summary>
public static class TaskSchd
{
/// <summary>Defines the type of actions that a task can perform.</summary>