mirror of
https://github.com/jcreek/Creek.FileRepository.git
synced 2026-07-12 18:33:43 +00:00
feat(*): Add documentation to File model to remove warnings
This commit is contained in:
@@ -1,17 +1,40 @@
|
||||
using System;
|
||||
using System.Collections.Generic;
|
||||
using System.IO;
|
||||
using System.Text;
|
||||
|
||||
namespace FileRepository.Models
|
||||
{
|
||||
/// <summary>
|
||||
/// This model serves to represent the files being stored.
|
||||
/// </summary>
|
||||
public class File
|
||||
{
|
||||
/// <summary>
|
||||
/// Gets or sets the id field for the file, this serves as the key field/unique identifier.
|
||||
/// </summary>
|
||||
public string Id { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the actual file name of the file.
|
||||
/// </summary>
|
||||
public string FileName { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the contents of the file, as a stream for easy manipulation.
|
||||
/// </summary>
|
||||
public Stream Content { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets the datetime object representing when this file object was created.
|
||||
/// </summary>
|
||||
public DateTime Created { get; set; }
|
||||
|
||||
/// <summary>
|
||||
/// Initialise a File model based on passed parameters.
|
||||
/// </summary>
|
||||
/// <param name="id">The id of the file.</param>
|
||||
/// <param name="fileName">The filename of the file.</param>
|
||||
/// <param name="content">The content of the file.</param>
|
||||
/// <returns>Returns an initialised File object.</returns>
|
||||
public File GenerateFile(string id, string fileName, Stream content)
|
||||
{
|
||||
File newFile = new File()
|
||||
@@ -19,7 +42,7 @@ namespace FileRepository.Models
|
||||
Id = id,
|
||||
FileName = fileName,
|
||||
Content = content,
|
||||
Created = DateTime.Now
|
||||
Created = DateTime.Now,
|
||||
};
|
||||
|
||||
return newFile;
|
||||
|
||||
Reference in New Issue
Block a user