Started working on a Steam library
This commit is contained in:
@@ -29,6 +29,8 @@ namespace OmegaLeo.HelperLib.Documentation.Models
|
||||
public string Title;
|
||||
public string Description;
|
||||
public string[] Parameters;
|
||||
public string[] MethodParameters;
|
||||
public string ReturnType;
|
||||
public string CodeExample = string.Empty;
|
||||
|
||||
[Documentation(nameof(DocumentationDescription), "Description of the current Documented object", new []
|
||||
@@ -36,13 +38,17 @@ namespace OmegaLeo.HelperLib.Documentation.Models
|
||||
"title - Name of the object",
|
||||
"description - Description of what the object does",
|
||||
"parameters - The parameters for the object (in case of a method with parameters)",
|
||||
"methodParameters - Reflected method parameter list when the documented member is a method",
|
||||
"returnType - Reflected return type when the documented member is a method",
|
||||
"codeExample - Code example of how to use the object"
|
||||
})]
|
||||
public DocumentationDescription(string title, string description, string[] parameters = default, string codeExample = "")
|
||||
public DocumentationDescription(string title, string description, string[]? parameters = null, string codeExample = "", string[]? methodParameters = null, string returnType = "")
|
||||
{
|
||||
Title = title;
|
||||
Description = description;
|
||||
Parameters = parameters ?? Array.Empty<string>();
|
||||
MethodParameters = methodParameters ?? Array.Empty<string>();
|
||||
ReturnType = returnType ?? string.Empty;
|
||||
CodeExample = codeExample;
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user