- update comments

pull/26/head
Simon Gockner 6 years ago
parent a4822183d5
commit 5a79ea6c2d
  1. 3
      GBase.Client/Services/Service.cs
  2. 3
      GBase/DataHandling/XmlDataReader.cs
  3. 3
      GBase/DataHandling/XmlDataWriter.cs
  4. 1
      GBase/Helpers/Enumerables.cs

@ -36,7 +36,8 @@ namespace GBase.Client.Services
/// </summary>
/// <param name="serverProtocol">The <see cref="ServerProtocol"/></param>
/// <param name="endpoint">The endpoint for this <typeparamref name="TService"/></param>
/// <returns></returns>
/// <returns>A <see cref="ChannelFactory{T}"/> for the <typeparamref name="TService"/></returns>
/// <exception cref="ArgumentOutOfRangeException">Invalid <see cref="ServerProtocol"/> used</exception>
private ChannelFactory<TService> OpenFactory(ServerProtocol serverProtocol, string endpoint)
{
ChannelFactory<TService> factory;

@ -42,6 +42,7 @@ namespace GBase.DataHandling
/// </summary>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> to cancel the async operation</param>
/// <returns>Returns true if successful, false if not</returns>
/// <exception cref="Exception">No root element found</exception>
public async Task<bool> Init(CancellationToken cancellationToken)
{
if (_isInitialized)
@ -66,6 +67,8 @@ namespace GBase.DataHandling
/// <typeparam name="TProperty">The <see cref="Type"/> of the property</typeparam>
/// <param name="propertyName">The name of the property</param>
/// <returns>The data of the given property, null if no data found</returns>
/// <exception cref="ArgumentNullException"><paramref name="propertyName"/></exception>
/// <exception cref="InvalidOperationException">Invalid <see cref="Type"/> found for the read object</exception>
public async Task<IEnumerable<TProperty>> Read<T, TProperty>(string propertyName)
//TODO: Read currently doesn't work for newly added items -> probably because file was loaded before new items were added; is probably not a problem -> cache
{

@ -43,6 +43,7 @@ namespace GBase.DataHandling
/// </summary>
/// <param name="cancellationToken">A <see cref="CancellationToken"/> to cancel the async operation</param>
/// <returns>Returns true if successful, false if not</returns>
/// <exception cref="Exception">No root element found</exception>
public async Task<bool> Init(CancellationToken cancellationToken)
{
if (_isInitialized)
@ -79,6 +80,7 @@ namespace GBase.DataHandling
/// <param name="value">The value of the property</param>
/// <param name="overwrite">If true an existing value is overwritten, if false an additional value is added</param>
/// <returns>A <see cref="Task"/> to await</returns>
/// <exception cref="ArgumentNullException"><paramref name="propertyName"/></exception>
public async Task Write<T, TProperty>(string propertyName, string value, bool overwrite)
{
string typeName = typeof(T).FullName;
@ -135,6 +137,7 @@ namespace GBase.DataHandling
/// <param name="propertyName">The name of the property</param>
/// <param name="value">The value to set</param>
/// <returns>A <see cref="Task"/> to await</returns>
/// <exception cref="ArgumentNullException"><paramref name="propertyName"/></exception>
public async Task Remove<T, TProperty>(string propertyName, string value)
{
string typeName = typeof(T).FullName;

@ -42,6 +42,7 @@ namespace GBase.Helpers
/// <typeparam name="TEnumerable">The <see cref="IEnumerable{T}"/> <see cref="Type"/></typeparam>
/// <param name="string">The given <see cref="string"/></param>
/// <returns>An <see cref="IEnumerable{T}"/> of <see cref="Type"/> <typeparamref name="TEnumerable"/></returns>
/// <exception cref="InterfaceEnumerablePassedException">Interface was passed to an <see cref="IEnumerable{T}"/></exception>
public static TEnumerable ConvertToGBaseEnumerable<TEnumerable>(string @string)
{
//get generic type parameter of TEnumerable

Loading…
Cancel
Save