From 762a5ba4b3d5d3a097939db4f838b127c493078e Mon Sep 17 00:00:00 2001 From: Simon Gockner Date: Thu, 13 Feb 2020 08:22:12 +0100 Subject: [PATCH] - update documentation xml files (#13) --- GBase.Client/GBase.Client.xml | 86 +++++----- GBase/GBase.xml | 290 +++++++++++++++++++++++++--------- 2 files changed, 255 insertions(+), 121 deletions(-) diff --git a/GBase.Client/GBase.Client.xml b/GBase.Client/GBase.Client.xml index b86ed1e..5992ff2 100644 --- a/GBase.Client/GBase.Client.xml +++ b/GBase.Client/GBase.Client.xml @@ -33,58 +33,19 @@ The GBaseEntry endpoint A newly created instance of the implementation for - - - Factory for the - - - - - Creates an - - The - The endpoint for the GBase - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The - The endpoint for the GBase - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The - The endpoint for the GBase - A newly created instance of the implementation for - A client for the GBase - + A client for the GBase The for this client - The - The - The + The + The + The @@ -216,6 +177,45 @@ Complete GBaseEntry endpoint address based on the + + + Factory for the + + + + + Creates an + + The + The endpoint for the GBase + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The + The endpoint for the GBase + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The + The endpoint for the GBase + A newly created instance of the implementation for + for the IGBaseEntry diff --git a/GBase/GBase.xml b/GBase/GBase.xml index 52029c7..6013248 100644 --- a/GBase/GBase.xml +++ b/GBase/GBase.xml @@ -19,12 +19,51 @@ Tags a class as a + + + Factory for the + + + + + Create an + + The that implements the property + The name of the property + The value of the property + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The name of the property + The value of the property + A newly created instance of the implementation for + An interface for the - + An interface for the @@ -67,7 +106,7 @@ Entry for the - + Entry for the @@ -113,6 +152,42 @@ The values of the property + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The path to the xml file + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The path to the xml file + The root element name of the xml file + A newly created instance of the implementation for + A that handles its data in an xml file @@ -128,7 +203,7 @@ The attribute name of the value attribute - + A that handles its data in an xml file @@ -269,6 +344,124 @@ A to await + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + The for this + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + Factory for the + + + + + Creates an + + A newly created instance of the implementation for + + + + Internal file handler + + + + + Initialize this + + The path of the database + A to cancel the asynchronous operation + True if successful, false if not + + + + Dispose used resources asynchronously + + A to await + + + + The base class of the GBase database + + + + + The base class of the GBase database + + The for this + + + + The name of this + + + + + The settings of this + + + + + The s of this + + + + + Initialize this + + The name of this + A to cancel the asynchronous operation + True if successful, false if not + + + + Add a given to this + + The given + True if successful, false if not + + + + Removes a given from this + + The given + True if successful, false if not + + + + Dispose used resources asynchronously + + A to await + An entry of a @@ -327,6 +520,22 @@ + + + for the file handling + + + + + + + + for the GBase + + + + + An interface for the @@ -502,45 +711,6 @@ The value to set A to await - - - Factory for the - - - - - Create an - - The that implements the property - The name of the property - The value of the property - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The name of the property - The value of the property - A newly created instance of the implementation for - An interface for the @@ -556,42 +726,6 @@ A property entry for the - - - Factory for the - - - - - Creates an - - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The path to the xml file - A newly created instance of the implementation for - - - - Factory for the - - - - - Creates an - - The path to the xml file - The root element name of the xml file - A newly created instance of the implementation for - A that handles its data in an xml file