Removed unnecessary files + added proper documentation to admin page generators

src/HopFrame.Web.Admin/Generators/IAdminContextGenerator.cs

@@ -2,6 +2,11 @@ namespace HopFrame.Web.Admin.Generators;
 
 public interface IAdminContextGenerator {
 
+    /// <summary>
+    /// Returns the generator object for the specified Admin Page. This needs to be within the same Admin Context.
+    /// </summary>
+    /// <typeparam name="TModel">The Model of the Admin Page</typeparam>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> Page<TModel>();
 
 }

src/HopFrame.Web.Admin/Generators/IAdminPageGenerator.cs

@@ -5,24 +5,105 @@ namespace HopFrame.Web.Admin.Generators;
 
 public interface IAdminPageGenerator<TModel> {
 
+    /// <summary>
+    /// Sets the title of the Admin Page
+    /// </summary>
+    /// <param name="title">the specified title</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> Title(string title);
+    
+    /// <summary>
+    /// Sets the description of the Admin Page
+    /// </summary>
+    /// <param name="description">the specified description</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> Description(string description);
+    
+    /// <summary>
+    /// Sets the url for the Admin Page
+    /// </summary>
+    /// <param name="url">the specified url (administration/{url})</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> Url(string url);
 
+    /// <summary>
+    /// Sets the permission needed to view the Admin Page
+    /// </summary>
+    /// <param name="permission">the specified permission</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ViewPermission(string permission);
+    
+    /// <summary>
+    /// Sets the permission needed to create a new Entry
+    /// </summary>
+    /// <param name="permission">the specified permission</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> CreatePermission(string permission);
+    
+    /// <summary>
+    /// Sets the permission needed to update an Entry
+    /// </summary>
+    /// <param name="permission">the specified permission</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> UpdatePermission(string permission);
+    
+    /// <summary>
+    /// Sets the permission needed to delete an Entry
+    /// </summary>
+    /// <param name="permission">the specified permission</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> DeletePermission(string permission);
 
+    
+    /// <summary>
+    /// Enables or disables the create button
+    /// </summary>
+    /// <param name="show">the specified state</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ShowCreateButton(bool show);
+    
+    /// <summary>
+    /// Enables or disables the delete button
+    /// </summary>
+    /// <param name="show">the specified state</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ShowDeleteButton(bool show);
+    
+    /// <summary>
+    /// Enables or disables the update button
+    /// </summary>
+    /// <param name="show">the specified state</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ShowUpdateButton(bool show);
 
+    /// <summary>
+    /// Specifies the default sort property and direction
+    /// </summary>
+    /// <param name="propertyExpression">Which property should be sorted</param>
+    /// <param name="direction">In which direction should be sorted</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> DefaultSort<TProperty>(Expression<Func<TModel, TProperty>> propertyExpression, ListSortDirection direction);
 
+    /// <summary>
+    /// Specifies the repository for the page
+    /// </summary>
+    /// <typeparam name="TRepository">The specified repository</typeparam>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ConfigureRepository<TRepository>() where TRepository : ModelRepository<TModel>;
     
+    
+    /// <summary>
+    /// Returns the generator of the specified property
+    /// </summary>
+    /// <param name="propertyExpression">The property</param>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Property<TProperty>(Expression<Func<TModel, TProperty>> propertyExpression);
+    
+    /// <summary>
+    /// Specifies the default property that should be displayed as a property in other listings
+    /// </summary>
+    /// <param name="propertyExpression">The property</param>
+    /// <returns></returns>
     IAdminPageGenerator<TModel> ListingProperty<TProperty>(Expression<Func<TModel, TProperty>> propertyExpression);
 
 }

src/HopFrame.Web.Admin/Generators/IAdminPropertyGenerator.cs

@@ -4,25 +4,120 @@ namespace HopFrame.Web.Admin.Generators;
 
 public interface IAdminPropertyGenerator<TProperty, TModel> {
 
+    /// <summary>
+    /// Should the property be sortable or not
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Sortable(bool sortable);
+    
+    /// <summary>
+    /// Should the admin be able to edit the property after creation or not
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Editable(bool editable);
+    
+    /// <summary>
+    /// Should the value of the property be displayed while editing or not (useful for passwords and tokens)
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> DisplayValueWhileEditing(bool display);
+    
+    /// <summary>
+    /// Should the property be a column on the page list or not
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> DisplayInListing(bool display = true);
+    
+    /// <summary>
+    /// Should the property be ignored completely
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Ignore(bool ignore = true);
+    
+    /// <summary>
+    /// Is the value of the property database generated and is not meant to be changed
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Generated(bool generated = true);
+    
+    /// <summary>
+    /// Should the property value be bold in the listing or not
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Bold(bool bold = true);
+    
+    /// <summary>
+    /// Is the value of the property unique under all other entries in the dataset
+    /// </summary>
+    /// <param name="unique"></param>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Unique(bool unique = true);
     
+    /// <summary>
+    /// Specifies the display name in the listing and editing/creation
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> DisplayName(string displayName);
-    IAdminPropertyGenerator<TProperty, TModel> Description(string description);
+    
+    /// <summary>
+    /// Has the value of the property a never changing prefix that doesn't need to be specified or displayed
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Prefix(string prefix);
+    
+    /// <summary>
+    /// The specified function gets called before creation/edit to verify that the entered value matches the property requirements
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Validator(Func<TProperty, string> validator);
+    
+    /// <summary>
+    /// Sets the input type in creation/edit to a selector for the property type. The property type needs to have its own admin page in order for the selector to work!
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> IsSelector(bool selector = true);
+    
+    /// <summary>
+    /// Sets the input type in creation/edit to a selector for the specified type. The specified type needs to have its own admin page in order for the selector to work!
+    /// </summary>
+    /// <param name="selector"></param>
+    /// <typeparam name="TSelectorType"></typeparam>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> IsSelector<TSelectorType>(bool selector = true);
+    
+    /// <summary>
+    /// The specified function gets called, whenever the entry is changed/created in order to convert the raw string input to the proper property type
+    /// </summary>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Parser(Func<TModel, string, TProperty> parser);
+    
+    /// <summary>
+    /// The specified function gets called, whenever the entry is changed/created in order to convert the raw string input to the proper property type
+    /// </summary>
+    /// <typeparam name="TInput">Needs to be specified if the field is not a plain string field (like a selector with a different type)</typeparam>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Parser<TInput>(Func<TModel, TInput, TProperty> parser);
+    
+    /// <summary>
+    /// The specified function gets called, whenever the entry is changed/created in order to convert the raw string input to the proper property type
+    /// </summary>
+    /// <typeparam name="TInput">Needs to be specified if the field is not a plain string field (like a selector with a different type)</typeparam>
+    /// <typeparam name="TInnerProperty">Needs to be specified if the property type is a List</typeparam>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> Parser<TInput, TInnerProperty>(Func<TModel, TInput, TInnerProperty> parser);
+    
+    /// <summary>
+    /// Specifies the default property that should be displayed as a value
+    /// </summary>
+    /// <param name="propertyExpression"></param>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> DisplayProperty(Expression<Func<TProperty, object>> propertyExpression);
+    
+    /// <summary>
+    /// Specifies the default property that should be displayed as a value
+    /// </summary>
+    /// <typeparam name="TInnerProperty">Needs to be specified if the property type is a List</typeparam>
+    /// <returns></returns>
     IAdminPropertyGenerator<TProperty, TModel> DisplayProperty<TInnerProperty>(Expression<Func<TInnerProperty, object>> propertyExpression);
 
 }

src/HopFrame.Web.Admin/Generators/IGenerator.cs

@@ -2,6 +2,10 @@ namespace HopFrame.Web.Admin.Generators;
 
 public interface IGenerator<out TGeneratedType> {
 
+    /// <summary>
+    /// Compiles the generator with all specified options
+    /// </summary>
+    /// <returns>The compiled data structure</returns>
     TGeneratedType Compile();
 
 }

src/HopFrame.Web.Admin/Generators/Implementation/AdminPropertyGenerator.cs

@@ -61,11 +61,6 @@ internal sealed class AdminPropertyGenerator<TProperty, TModel>(string name, Typ
         return this;
     }
 
-    public IAdminPropertyGenerator<TProperty, TModel> Description(string description) {
-        _property.Description = description;
-        return this;
-    }
-
     public IAdminPropertyGenerator<TProperty, TModel> Prefix(string prefix) {
         _property.Prefix = prefix;
         return this;
@@ -152,11 +147,6 @@ internal sealed class AdminPropertyGenerator<TProperty, TModel>(string name, Typ
             var attribute = attributes.Single(a => a is AdminNameAttribute) as AdminNameAttribute;
             DisplayName(attribute?.Name);
         }
-            
-        if (attributes.Any(a => a is AdminDescriptionAttribute)) {
-            var attribute = attributes.Single(a => a is AdminDescriptionAttribute) as AdminDescriptionAttribute;
-            Description(attribute?.Description);
-        }
         
         if (attributes.Any(a => a is AdminBoldAttribute)) {
             var attribute = attributes.Single(a => a is AdminBoldAttribute) as AdminBoldAttribute;

src/HopFrame.Web.Admin/Models/AdminPage.cs

@@ -13,9 +13,8 @@ public class AdminPage {
     public IList<AdminPageProperty> Properties { get; set; }
     public string ListingProperty { get; set; }
     
-    [JsonIgnore]
     public Type RepositoryProvider { get; set; }
-
+    
     public Type ModelType { get; set; }
     
     public string DefaultSortPropertyName { get; set; }

src/HopFrame.Web.Admin/Models/AdminPageProperty.cs

@@ -5,7 +5,6 @@ namespace HopFrame.Web.Admin.Models;
 public sealed class AdminPageProperty {
     public string Name { get; set; }
     public string DisplayName { get; set; }
-    public string Description { get; set; }
     public string Prefix { get; set; }
     public string DisplayPropertyName { get; set; }
 
@@ -21,7 +20,6 @@ public sealed class AdminPageProperty {
     public bool Selector { get; set; }
     public Type SelectorType { get; set; }
     
-    [JsonIgnore]
     public Type Type { get; set; }
 
     public Func<object, string> Validator { get; set; }