Merge pull request #30 from FrendsPlatform/issue-29

LDAP.SearchObjects - Updated documentation

Author: ttossavainen

Frends.LDAP.SearchObjects/CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## [3.1.0] - 2025-04-01
+### Added
+- Added example values for new parameters.
+
 ## [3.0.0] - 2025-03-17
 ### Added
 [Breaking]

Frends.LDAP.SearchObjects/Frends.LDAP.SearchObjects/Definitions/Input.cs

@@ -97,13 +97,21 @@ public class Input
     /// Determine if only specified attributes should be returned.
     /// This allows user to specify encoding and type for certain attributes.
     /// </summary>
+    /// <example>false</example>
     [DefaultValue(true)]
     public bool SearchOnlySpecifiedAttributes { get; set; }
 
     /// <summary>
     /// The names of attributes to retrieve.
     /// </summary>
-    /// <example>cn</example>
+    /// <example>
+    /// new Attributes[]
+    /// {
+    ///     new Attributes { Key = "title", ReturnType = ReturnType.String },
+    ///     new Attributes { Key = "objectGUID", ReturnType = ReturnType.Guid },
+    ///     new Attributes { Key = "photo", ReturnType = ReturnType.ByteArray }
+    /// }
+    /// </example>
     public Attributes[] Attributes { get; set; } = Array.Empty<Attributes>();
 }
 
@@ -121,6 +129,7 @@ public class Attributes
     /// <summary>
     /// Determines the return type of the attribute.
     /// </summary>
+    /// <example>ReturnType.Guid</example>
     [DefaultValue(ReturnType.String)]
     public ReturnType ReturnType { get; set; }
 }

Frends.LDAP.SearchObjects/Frends.LDAP.SearchObjects/Frends.LDAP.SearchObjects.csproj

@@ -2,7 +2,7 @@
 
   <PropertyGroup>
 	<TargetFrameworks>net6.0</TargetFrameworks>
-	<Version>3.0.0</Version>
+	<Version>3.1.0</Version>
 	<Authors>Frends</Authors>
 	<Copyright>Frends</Copyright>
 	<Company>Frends</Company>