Merge pull request 'SES-82 Added description to view models' (#20) from SES-82 into master

Reviewed-on: #20

SessionCompanion/SessionCompanion.ViewModels/AlignmentViewModels/AlignmentViewModel.cs

@@ -1,12 +1,10 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.AlignmentViewModels
+namespace SessionCompanion.ViewModels.AlignmentViewModels
 {
     public class AlignmentViewModel
     {
+        /// <summary>
+        /// Identyfikator przynależności postaci
+        /// </summary>
         public int Id { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/BackgroundViewModels/BackgroundViewModel.cs

@@ -1,12 +1,10 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.BackgroundViewModels
+namespace SessionCompanion.ViewModels.BackgroundViewModels
 {
     public class BackgroundViewModel
     {
+        /// <summary>
+        /// Identyfikator przeszłości postaci
+        /// </summary>
         public int Id { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/BiographyViewModels/BiographyViewModel.cs

@@ -1,18 +1,40 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.BiographyViewModels
+namespace SessionCompanion.ViewModels.BiographyViewModels
 {
     public class BiographyViewModel
     {
+        /// <summary>
+        /// Identyfikator biografii postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Nazwa postaci
+        /// </summary>
         public string Name { get; set; }
+
+        /// <summary>
+        /// Identyfikator klasy postaci
+        /// </summary>
         public int ClassId { get; set; }
+
+        /// <summary>
+        /// Identyfikator przynależności postaci
+        /// </summary>
         public int AlignmentId { get; set; }
+
+        /// <summary>
+        /// Identyfikator przeszłości postaci
+        /// </summary>
         public int BackgroundId { get; set; }
+
+        /// <summary>
+        /// Płeć postaci
+        /// </summary>
         public string Sex { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/CharacterViewModels/CharacterBasicStatsViewModel.cs

@@ -3,7 +3,7 @@
     public class CharacterBasicStatsViewModel
     {
         /// <summary>
-        /// Identyfikator psotaci
+        /// Identyfikator postaci
         /// </summary>
         public int Id { get; set; }
 

SessionCompanion/SessionCompanion.ViewModels/CharacterViewModels/CharacterForLoginViewModel.cs

@@ -3,7 +3,7 @@
     public class CharacterForLoginViewModel
     {
         /// <summary>
-        /// Identyfikator psotaci
+        /// Identyfikator postaci
         /// </summary>
         public int Id { get; set; }
 

SessionCompanion/SessionCompanion.ViewModels/CharacterViewModels/CharacterViewModel.cs

@@ -3,7 +3,7 @@
     public class CharacterViewModel
     {
         /// <summary>
-        /// Identyfikator psotaci
+        /// Identyfikator postaci
         /// </summary>
         public int Id { get; set; }
 

SessionCompanion/SessionCompanion.ViewModels/CharismaViewModels/CharismaViewModel.cs

@@ -1,25 +1,75 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.CharismaViewModels
+namespace SessionCompanion.ViewModels.CharismaViewModels
 {
     public class CharismaViewModel
     {
+        /// <summary>
+        /// Identyfikator charyzmy postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość charyzmy
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w charyźmie
+        /// </summary>
         public bool CanSaveThrows { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności oszustwa
+        /// </summary>
         public int Deception { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w oszustwie
+        /// </summary>
         public bool CanDeception { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności zastraszania
+        /// </summary>
         public int Intimidation { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w zastraszaniu
+        /// </summary>
         public bool CanIntimidation { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności występowania
+        /// </summary>
         public int Performance { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w występowaniu
+        /// </summary>
         public bool CanPerformance { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności perswazji
+        /// </summary>
         public int Persuasion { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w perswazji
+        /// </summary>
         public bool CanPersuasion { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/ClassViewModels/ClassViewModel.cs

@@ -7,7 +7,14 @@ namespace SessionCompanion.ViewModels.ClassViewModels
 {
     public class ClassViewModel
     {
+        /// <summary>
+        /// Identyfikator klasy postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Nazwa klasy
+        /// </summary>
         public string Name { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/ConstitutionViewModels/ConstitutionViewModel.cs

@@ -1,17 +1,35 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.ConstitutionViewModels
+namespace SessionCompanion.ViewModels.ConstitutionViewModels
 {
     public class ConstitutionViewModel
     {
+        /// <summary>
+        /// Identyfikator kondycji postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość kondycji
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w kondycji
+        /// </summary>
         public bool CanSaveThrows { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/DexterityViewModels/DexterityViewModel.cs

@@ -1,23 +1,65 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.DexterityViewModels
+namespace SessionCompanion.ViewModels.DexterityViewModels
 {
     public class DexterityViewModel
     {
+        /// <summary>
+        /// Identyfikator zręczności postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość zręczności
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w zręczności
+        /// </summary>
         public bool CanSaveThrows { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności akrobatyki
+        /// </summary>
         public int Acrobatics { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w akrobatyce
+        /// </summary>
         public bool CanAcrobatics { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności zwinnych dłoni
+        /// </summary>
         public int SleightOfHand { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w zwinnych dłoniach
+        /// </summary>
         public bool CanSleightOfHand { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności skradania się
+        /// </summary>
         public int Stealth { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w skradaniu się
+        /// </summary>
         public bool CanStealth { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/IntelligenceViewModels/IntelligenceViewModel.cs

@@ -1,27 +1,85 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.IntelligenceViewModels
+namespace SessionCompanion.ViewModels.IntelligenceViewModels
 {
     public class IntelligenceViewModel
     {
+        /// <summary>
+        /// Identyfikator inteligencji postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość inteligencji
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w inteligencji
+        /// </summary>
         public bool CanSaveThrows { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności wiedzy tejemnej
+        /// </summary>
         public int Arcana { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w wiedzy tejemnej
+        /// </summary>
         public bool CanArcana { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności historii
+        /// </summary>
         public int History { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w historii
+        /// </summary>
         public bool CanHistory { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności śledztwa
+        /// </summary>
         public int Investigation { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w śledztwie
+        /// </summary>
         public bool CanInvestigation { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności przyrody
+        /// </summary>
         public int Nature { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w przyrodzie
+        /// </summary>
         public bool CanNature { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności religii
+        /// </summary>
         public int Religion { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w religii
+        /// </summary>
         public bool CanReligion { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/RaceViewModels/RaceViewModel.cs

@@ -1,13 +1,15 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.RaceViewModels
+namespace SessionCompanion.ViewModels.RaceViewModels
 {
     public class RaceViewModel
     {
+        /// <summary>
+        /// Identyfikator rasy postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Nazwa rasy
+        /// </summary>
         public string Name { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/StatisticsViewModels/StatisticsViewModel.cs

@@ -1,28 +1,64 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
+using System.ComponentModel.DataAnnotations;
 
 namespace SessionCompanion.ViewModels.StatisticsViewModels
 {
     public class StatisticsViewModel
     {
+
+        /// <summary>
+        /// Identyfikator statystyk postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
-        [Range(0, int.MaxValue)]
+
+        /// <summary>
+        /// Ilość punktów doświadczenia
+        /// </summary>
         public int ExperiencePoints { get; set; }
+
+        /// <summary>
+        /// Poziom postaci
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int Level { get; set; }
+
+        /// <summary>
+        /// Szybkość postaci
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int Speed { get; set; }
+
+        /// <summary>
+        /// Inicjatywa postaci
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int Initiative { get; set; }
+
+        /// <summary>
+        /// Maksymalna wartość punktów życia
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int HealthPoints { get; set; }
+
+        /// <summary>
+        /// Aktualna wartość punktów życia
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int CurrentHealthPoints { get; set; }
+
+        /// <summary>
+        /// Klasa pancerza
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int ArmorClass { get; set; }
+
+        /// <summary>
+        /// Premia z biegłości
+        /// </summary>
         [Range(0, int.MaxValue)]
         public int Proficiency { get; set; }
     }

SessionCompanion/SessionCompanion.ViewModels/StrengthViewModels/StrengthViewModel.cs

@@ -1,19 +1,45 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.StrengthViewModels
+namespace SessionCompanion.ViewModels.StrengthViewModels
 {
     public class StrengthViewModel
     {
+        /// <summary>
+        /// Identyfikator siły postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość siły
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w sile
+        /// </summary>
         public bool CanSaveThrows { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności atletyki
+        /// </summary>
         public int Athletics { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w atletyce
+        /// </summary>
         public bool CanAthletics { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/UserViewModels/UserViewModel.cs

@@ -1,14 +1,20 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.UserViewModels
+namespace SessionCompanion.ViewModels.UserViewModels
 {
     public class UserViewModel
     {
+        /// <summary>
+        /// Identyfikator użytkownika
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Nazwa użytkowika
+        /// </summary>
         public string Nickname { get; set; }
+
+        /// <summary>
+        /// Hasło użytkownika
+        /// </summary>
         public string Password { get; set; }
     }
 }

SessionCompanion/SessionCompanion.ViewModels/WisdomViewModels/WisdomViewModel.cs

@@ -1,27 +1,85 @@
-using System;
-using System.Collections.Generic;
-using System.ComponentModel.DataAnnotations;
-using System.Text;
-
-namespace SessionCompanion.ViewModels.WisdomViewModels
+namespace SessionCompanion.ViewModels.WisdomViewModels
 {
     public class WisdomViewModel
     {
+        /// <summary>
+        /// Identyfikator mądrości postaci
+        /// </summary>
         public int Id { get; set; }
+
+        /// <summary>
+        /// Identyfikator postaci
+        /// </summary>
         public int CharacterId { get; set; }
+
+        /// <summary>
+        /// Wartość mądrości
+        /// </summary>
         public int Value { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów
+        /// </summary>
         public int Modification { get; set; }
+
+        /// <summary>
+        /// Modyfikator rzutów obronnych
+        /// </summary>
         public int SavingThrows { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w mądrości
+        /// </summary>
         public bool CanSaveThrows { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności opieki nad zwierzętami
+        /// </summary>
         public int AnimalHandling { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w opiece nad zwierzętami
+        /// </summary>
         public bool CanAnimalHandling { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności intuicji
+        /// </summary>
         public int Insight { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w intuicji
+        /// </summary>
         public bool CanInsight { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności medycyny
+        /// </summary>
         public int Medicine { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w medycynie 
+        /// </summary>
         public bool CanMedicine { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności percepcji
+        /// </summary>
         public int Perception { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w  percepcji
+        /// </summary>
         public bool CanPerception { get; set; }
+
+        /// <summary>
+        /// Wartość umiejętności sztuki przetrwania
+        /// </summary>
         public int Survival { get; set; }
+
+        /// <summary>
+        /// Czy postać posiada biegłość w sztuce przetrwania
+        /// </summary>
         public bool CanSurvival { get; set; }
     }
 }