Skip to content

Commit

Permalink
First attempt at documenting the NewsLetterFile (#255)
Browse files Browse the repository at this point in the history
* First attempt at documenting the NewsLetterFile

* Refactored documentation for field Location

* Removed depricated comments
  • Loading branch information
crex424 authored Aug 2, 2023
1 parent b807918 commit 6e90f3c
Showing 1 changed file with 15 additions and 3 deletions.
18 changes: 15 additions & 3 deletions PC2/Models/NewsletterFile.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,15 +2,27 @@

namespace PC2.Models
{
/// <summary>
/// Represents the NewsLetterFile
/// </summary>
public class NewsletterFile
{
[Key] // for naming the newsletter
/// <summary>
/// The unique identifier for the NewsLetter
/// </summary>
[Key]
public int NewsletterId { get; set; }

[Required] // must be the filename
/// <summary>
/// The name of the NewsLetterFile
/// </summary>
[Required]
public string Name { get; set; } = null!;

[Required] // used to create dynamic links
/// <summary>
/// The location of the NewsLetterFile in the storage device
/// </summary>
[Required]
public string Location { get; set; } = null!;

}
Expand Down

0 comments on commit 6e90f3c

Please sign in to comment.