Skip to content

Commit b301497

Browse files
committed
Added summaries for various properties
1 parent 1a1e185 commit b301497

File tree

4 files changed

+60
-0
lines changed

4 files changed

+60
-0
lines changed

classeviva-net/Grade.cs

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,25 @@ namespace ClassevivaNet
44
{
55
public class Grade
66
{
7+
/// <summary>
8+
/// Teacher's comment on the grade
9+
/// </summary>
710
public string Comment { get; }
11+
/// <summary>
12+
/// The date this grade was created
13+
/// </summary>
814
public DateTime Date { get; }
15+
/// <summary>
16+
/// The subject this grade was gotten in
17+
/// </summary>
918
public string Subject { get; }
19+
/// <summary>
20+
/// Type of the grade (oral, test, etc.) WARNING: Returns a string in Italian
21+
/// </summary>
1022
public string Type { get; }
23+
/// <summary>
24+
/// Whether this grade counts towards the main average grade
25+
/// </summary>
1126
public bool CountsTowardsAverage { get; }
1227

1328
public Grade (string comment, DateTime date, string subject, string type, bool countsTowardsAverage)

classeviva-net/Homework.cs

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,37 @@ namespace ClassevivaNet
44
{
55
public class Homework
66
{
7+
/// <summary>
8+
/// ID of the assignment
9+
/// </summary>
710
public string Id { get; }
11+
/// <summary>
12+
/// Title of the assignment
13+
/// </summary>
814
public string Title { get; }
15+
/// <summary>
16+
/// Date on which the assignment started
17+
/// </summary>
918
public DateTime StartDate { get; }
19+
/// <summary>
20+
/// Date on which the assignment ended
21+
/// </summary>
1022
public DateTime EndDate { get; }
23+
/// <summary>
24+
/// Whether the assignment is for the whole day
25+
/// </summary>
1126
public bool IsAllDay { get; }
27+
/// <summary>
28+
/// The date on which the assignment was created
29+
/// </summary>
1230
public DateTime CreationDate { get; }
31+
/// <summary>
32+
/// Author of the assignment
33+
/// </summary>
1334
public string Author { get; }
35+
/// <summary>
36+
/// Content of the assignment
37+
/// </summary>
1438
public string Content { get; }
1539

1640
public Homework(string id, string title, DateTime startDate, DateTime endDate, bool isAllDay, DateTime creationDate, string author, string content)

classeviva-net/MaterialFile.cs

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,29 @@ namespace ClassevivaNet
44
{
55
public class MaterialFile
66
{
7+
/// <summary>
8+
/// Author of the file
9+
/// </summary>
710
public string Author { get; }
11+
/// <summary>
12+
/// Description of the file
13+
/// </summary>
814
public string Description { get; }
15+
/// <summary>
16+
/// Link to the file
17+
/// </summary>
918
public string Link { get; }
19+
/// <summary>
20+
/// The name of the folder containing the file
21+
/// </summary>
1022
public string RootFolder { get; }
23+
/// <summary>
24+
/// The date on which this file was created
25+
/// </summary>
1126
public DateTime Date { get; }
27+
/// <summary>
28+
/// Type of the file (File, Link)
29+
/// </summary>
1230
public MaterialFileType MaterialFileType { get; }
1331

1432
public MaterialFile(string author, string description, string link, string rootFolder, MaterialFileType materialFileType, DateTime date)

classeviva-net/MaterialFileType.cs

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
namespace ClassevivaNet
22
{
3+
/// <summary>
4+
/// Types of files
5+
/// </summary>
36
public enum MaterialFileType
47
{
58
Link,

0 commit comments

Comments
 (0)