Skip to content

Commit

Permalink
doc - Corrected docs and debug previews
Browse files Browse the repository at this point in the history
---

We've made the documentation better and less confusing then before.

---

Type: doc
Breaking: False
Doc Required: False
Backport Required: False
Part: 1/1
  • Loading branch information
AptiviCEO committed Sep 29, 2024
1 parent a76fa18 commit c4a8abf
Show file tree
Hide file tree
Showing 44 changed files with 61 additions and 61 deletions.
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Calendar.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count} | I [{integers.Count}])")]
public class Calendar : IEquatable<Calendar>
{
internal readonly List<CalendarEvent> events = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarAlarm.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar alarm version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar alarm version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarAlarm : Calendar, IEquatable<CalendarAlarm>
{
private readonly Dictionary<CalendarPartsArrayEnum, List<BaseCalendarPartInfo>> partsArray = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarDaylight.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar daylight time version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar daylight time version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarDaylight : Calendar, IEquatable<CalendarDaylight>
{
private readonly Dictionary<CalendarPartsArrayEnum, List<BaseCalendarPartInfo>> partsArray = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar event version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar event version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarEvent : Calendar, IEquatable<CalendarEvent>
{
internal readonly List<CalendarAlarm> alarms = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarFreeBusy.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar free/busy version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar free/busy version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarFreeBusy : Calendar, IEquatable<CalendarFreeBusy>
{
private readonly Dictionary<CalendarPartsArrayEnum, List<BaseCalendarPartInfo>> partsArray = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarJournal.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar journal version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar journal version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarJournal : Calendar, IEquatable<CalendarJournal>
{
private readonly Dictionary<CalendarPartsArrayEnum, List<BaseCalendarPartInfo>> partsArray = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarStandard.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar standard time version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar standard time version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarStandard : Calendar, IEquatable<CalendarStandard>
{
private readonly Dictionary<CalendarPartsArrayEnum, List<BaseCalendarPartInfo>> partsArray = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarTimeZone.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar timezone version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar timezone version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarTimeZone : Calendar, IEquatable<CalendarTimeZone>
{
internal readonly List<CalendarStandard> standards = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/CalendarTodo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts
/// <summary>
/// A vCalendar card instance
/// </summary>
[DebuggerDisplay("vCalendar todo version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}])")]
[DebuggerDisplay("vCalendar todo version {CalendarVersion.ToString()}, parts: (A [{partsArray.Count}] | S [{strings.Count}] | I [{integers.Count}])")]
public class CalendarTodo : Calendar, IEquatable<CalendarTodo>
{
internal readonly List<CalendarAlarm> alarms = [];
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/AttachInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ namespace VisualCard.Calendar.Parts.Implementations
/// <summary>
/// Calendar attach info
/// </summary>
[DebuggerDisplay("Attach, {Encoding}, {AttachType}, {ValueType}")]
[DebuggerDisplay("Attach, {Encoding}, {ValueType}")]
public class AttachInfo : BaseCalendarPartInfo, IEquatable<AttachInfo>
{
/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions VisualCard.Calendar/Parts/Implementations/CommentInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
namespace VisualCard.Calendar.Parts.Implementations
{
/// <summary>
/// Contact comment info
/// Calendar comment info
/// </summary>
[DebuggerDisplay("Comment = {Comment}")]
public class CommentInfo : BaseCalendarPartInfo, IEquatable<CommentInfo>
{
/// <summary>
/// The contact's comment
/// The calendar's comment
/// </summary>
public string? Comment { get; }

Expand Down
4 changes: 2 additions & 2 deletions VisualCard.Calendar/Parts/Implementations/DateCreatedInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace VisualCard.Calendar.Parts.Implementations
{
/// <summary>
/// Card date created info
/// Calendar date created info
/// </summary>
[DebuggerDisplay("Date Created = {DateCreated}")]
public class DateCreatedInfo : BaseCalendarPartInfo, IEquatable<DateCreatedInfo>
{
/// <summary>
/// The card's revision
/// The calendar's creation date
/// </summary>
public DateTimeOffset DateCreated { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
namespace VisualCard.Calendar.Parts.Implementations.Event
{
/// <summary>
/// Contact categories info
/// Event categories info
/// </summary>
[DebuggerDisplay("Categories = {Categories}")]
[DebuggerDisplay("{Categories.Length} categories")]
public class CategoriesInfo : BaseCalendarPartInfo, IEquatable<CategoriesInfo>
{
/// <summary>
/// The contact's categories
/// The calendar event's categories
/// </summary>
public string[]? Categories { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace VisualCard.Calendar.Parts.Implementations.Event
{
/// <summary>
/// Card date end info
/// Event date end info
/// </summary>
[DebuggerDisplay("Date End = {dateEnd}")]
[DebuggerDisplay("Date End = {DateEnd}")]
public class DateEndInfo : BaseCalendarPartInfo, IEquatable<DateEndInfo>
{
/// <summary>
/// The card's revision
/// The event's end date
/// </summary>
public DateTimeOffset DateEnd { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace VisualCard.Calendar.Parts.Implementations.Event
{
/// <summary>
/// Card date stamp info
/// Event date stamp info
/// </summary>
[DebuggerDisplay("Date Stamp = {dateStamp}")]
[DebuggerDisplay("Date Stamp = {DateStamp}")]
public class DateStampInfo : BaseCalendarPartInfo, IEquatable<DateStampInfo>
{
/// <summary>
/// The card's revision
/// The event's date stamp
/// </summary>
public DateTimeOffset DateStamp { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace VisualCard.Calendar.Parts.Implementations.Event
{
/// <summary>
/// Card date start info
/// Event date start info
/// </summary>
[DebuggerDisplay("Date Start = {dateStart}")]
[DebuggerDisplay("Date Start = {DateStart}")]
public class DateStartInfo : BaseCalendarPartInfo, IEquatable<DateStartInfo>
{
/// <summary>
/// The card's revision
/// The event's start date
/// </summary>
public DateTimeOffset DateStart { get; }

Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/ExDateInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations
/// <summary>
/// Calendar excluded date info
/// </summary>
[DebuggerDisplay("ExDate = {ExDates}")]
[DebuggerDisplay("{ExDates.Length} excluded dates")]
public class ExDateInfo : BaseCalendarPartInfo, IEquatable<ExDateInfo>
{
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/GeoInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ namespace VisualCard.Calendar.Parts.Implementations
/// <summary>
/// Event or to-do geographical information
/// </summary>
[DebuggerDisplay("Geography = {Geo}")]
[DebuggerDisplay("Geography = {Latitude}, {Longitude}")]
public class GeoInfo : BaseCalendarPartInfo, IEquatable<GeoInfo>
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace VisualCard.Calendar.Parts.Implementations
public class LastModifiedInfo : BaseCalendarPartInfo, IEquatable<LastModifiedInfo>
{
/// <summary>
/// The card's revision
/// The calendar's revision
/// </summary>
public DateTimeOffset LastModified { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations.Legacy
/// <summary>
/// Event audio alarm information
/// </summary>
[DebuggerDisplay("AudioAlarm = {Flag}")]
[DebuggerDisplay("Audio Alarm = @ {RunTime}, {SnoozeTime}, {RepeatCount} times, {AudioResource}")]
public class AudioAlarmInfo : BaseCalendarPartInfo, IEquatable<AudioAlarmInfo>
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations.Legacy
/// <summary>
/// Daylight information (entire calendar)
/// </summary>
[DebuggerDisplay("Daylight = {Flag}")]
[DebuggerDisplay("Daylight Alarm = {Flag} @ {UtcOffset} (Daylight: {DaylightStart} -> {DaylightEnd} {DaylightDesignation}), {StandardDesignation}")]
public class DaylightInfo : BaseCalendarPartInfo, IEquatable<DaylightInfo>
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations.Legacy
/// <summary>
/// Event display alarm information
/// </summary>
[DebuggerDisplay("DisplayAlarm = {Flag}")]
[DebuggerDisplay("Display Alarm = @ {RunTime}, {SnoozeTime}, {RepeatCount} times, {Display}")]
public class DisplayAlarmInfo : BaseCalendarPartInfo, IEquatable<DisplayAlarmInfo>
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations.Legacy
/// <summary>
/// Event note alarm information
/// </summary>
[DebuggerDisplay("NoteAlarm = {Flag}")]
[DebuggerDisplay("Mail Alarm = @ {RunTime}, {SnoozeTime}, {RepeatCount} times, {Address}, {Note}")]
public class MailAlarmInfo : BaseCalendarPartInfo, IEquatable<MailAlarmInfo>
{
/// <summary>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations.Legacy
/// <summary>
/// Event procedure alarm information
/// </summary>
[DebuggerDisplay("ProcedureAlarm = {Flag}")]
[DebuggerDisplay("Procedure Alarm = @ {RunTime}, {SnoozeTime}, {RepeatCount} times, {Procedure}")]
public class ProcedureAlarmInfo : BaseCalendarPartInfo, IEquatable<ProcedureAlarmInfo>
{
/// <summary>
Expand Down
4 changes: 2 additions & 2 deletions VisualCard.Calendar/Parts/Implementations/LocationInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -25,13 +25,13 @@
namespace VisualCard.Calendar.Parts.Implementations
{
/// <summary>
/// Contact location info
/// Calendar location info
/// </summary>
[DebuggerDisplay("Location = {Location}")]
public class LocationInfo : BaseCalendarPartInfo, IEquatable<LocationInfo>
{
/// <summary>
/// The contact's location
/// The calendar's location
/// </summary>
public string? Location { get; }

Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/RecDateInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ namespace VisualCard.Calendar.Parts.Implementations
/// <summary>
/// Calendar recurrence date info
/// </summary>
[DebuggerDisplay("RecDate = {RecDates.Length} dates")]
[DebuggerDisplay("{RecDates.Length} recurrence dates")]
public class RecDateInfo : BaseCalendarPartInfo, IEquatable<RecDateInfo>
{
/// <summary>
Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/RelatedToInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Calendar.Parts.Implementations
/// <summary>
/// Calendar relationship info
/// </summary>
[DebuggerDisplay("RelatedTo = {RelatedTo}")]
[DebuggerDisplay("Related to = {RelatedTo}")]
public class RelatedToInfo : BaseCalendarPartInfo, IEquatable<RelatedToInfo>
{
/// <summary>
Expand Down
6 changes: 3 additions & 3 deletions VisualCard.Calendar/Parts/Implementations/ResourcesInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,13 +26,13 @@
namespace VisualCard.Calendar.Parts.Implementations
{
/// <summary>
/// Contact resources info
/// Calendar resources info
/// </summary>
[DebuggerDisplay("Resources = {Resources}")]
[DebuggerDisplay("{Resources.Length} resources")]
public class ResourcesInfo : BaseCalendarPartInfo, IEquatable<ResourcesInfo>
{
/// <summary>
/// The contact's resources
/// The calendar's resources
/// </summary>
public string[]? Resources { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,11 +27,11 @@ namespace VisualCard.Calendar.Parts.Implementations.TimeZone
/// <summary>
/// Calendar time zone name info
/// </summary>
[DebuggerDisplay("TimeZoneName = {TimeZoneName}")]
[DebuggerDisplay("Time Zone Name = {TimeZoneName}")]
public class TimeZoneNameInfo : BaseCalendarPartInfo, IEquatable<TimeZoneNameInfo>
{
/// <summary>
/// The timezonename address
/// The time zone name
/// </summary>
public string? TimeZoneName { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ namespace VisualCard.Calendar.Parts.Implementations.TimeZone
/// <summary>
/// Time zone offset from info
/// </summary>
[DebuggerDisplay("Time zone offset from = {offset}")]
[DebuggerDisplay("Time zone offset from = {Offset}")]
public class TimeZoneOffsetFromInfo : BaseCalendarPartInfo, IEquatable<TimeZoneOffsetFromInfo>
{
/// <summary>
/// The card's revision
/// Time zone offset
/// </summary>
public TimeSpan Offset { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ namespace VisualCard.Calendar.Parts.Implementations.TimeZone
/// <summary>
/// Time zone offset to info
/// </summary>
[DebuggerDisplay("Time zone offset to = {offset}")]
[DebuggerDisplay("Time zone offset to = {Offset}")]
public class TimeZoneOffsetToInfo : BaseCalendarPartInfo, IEquatable<TimeZoneOffsetToInfo>
{
/// <summary>
/// The card's revision
/// Time zone offset
/// </summary>
public TimeSpan Offset { get; }

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@
namespace VisualCard.Calendar.Parts.Implementations.Todo
{
/// <summary>
/// Card date completed info
/// To-do date completed info
/// </summary>
[DebuggerDisplay("Date Completed = {DateCompleted}")]
public class DateCompletedInfo : BaseCalendarPartInfo, IEquatable<DateCompletedInfo>
Expand Down
4 changes: 2 additions & 2 deletions VisualCard.Calendar/Parts/Implementations/Todo/DueDateInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,13 @@
namespace VisualCard.Calendar.Parts.Implementations.Todo
{
/// <summary>
/// Due date info
/// To-do due date info
/// </summary>
[DebuggerDisplay("Due = {DueDate}")]
public class DueDateInfo : BaseCalendarPartInfo, IEquatable<DueDateInfo>
{
/// <summary>
/// The to-do completion date
/// The to-do due date
/// </summary>
public DateTimeOffset DueDate { get; }

Expand Down
2 changes: 1 addition & 1 deletion VisualCard.Calendar/Parts/Implementations/XNameInfo.cs
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
namespace VisualCard.Calendar.Parts.Implementations
{
/// <summary>
/// Contact non-standard field entry information
/// Calendar non-standard field entry information
/// </summary>
[DebuggerDisplay("Non-standard: {XKeyName} = {string.Join(\", \", XValues)}")]
public class XNameInfo : BaseCalendarPartInfo, IEquatable<XNameInfo>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ namespace VisualCard.Parts.Implementations
/// <summary>
/// Contact calendar scheduling request URL info
/// </summary>
[DebuggerDisplay("Calendar Scheduling Request URL, {CalendarSchedulingRequestUrl}")]
[DebuggerDisplay("Calendar Scheduling Request URL = {CalendarSchedulingRequestUrl}")]
public class CalendarSchedulingRequestUrlInfo : BaseCardPartInfo, IEquatable<CalendarSchedulingRequestUrlInfo>
{
/// <summary>
Expand Down
Loading

0 comments on commit c4a8abf

Please sign in to comment.