Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fixed some typos in comments and strings. #124

Merged
merged 1 commit into from
Jun 24, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom.Tests/Equality/GedcomEventTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ namespace GeneGenie.Gedcom.Tests.Equality
using Xunit;

/// <summary>
/// Tests for equality of family records.
/// Tests for equality of GedcomEvent.
/// </summary>
public class GedcomEventTest
{
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom.Tests/Equality/GedcomHeaderTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace GeneGenie.Gedcom.Tests.Equality
using Xunit;

/// <summary>
/// Tests for equality of multimedia files.
/// Tests for equality of headers.
/// </summary>
public class GedcomHeaderTest
{
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom.Tests/Equality/GedcomPlaceTest.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ namespace GeneGenie.Gedcom.Tests.Equality
using Xunit;

/// <summary>
/// Tests for equality of family records.
/// Tests for equality of GedcomPlace.
/// </summary>
public class GedcomPlaceTest
{
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/Data/StaticDateData.cs
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public static class StaticDateData
/// Longer strings that match the start of shorter strings should be listed first (ABT. before ABT).
///
/// Of particular note;
/// C or CIRCA from BROSKEEP files, C may be due to the date being set from a baptism / christening, but if that is the
/// C or CIRCA from BROSKEEP files, C may be due to the date being set from a baptism / christening, but if that is the
/// case estimate is still reasonable to go with.
///
/// BROSKEEP seems to be stupid and doesn't make proper use of CAL e.g 'BU.9-6-1825' for a death date means it is really
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/Enums/GedcomDatePeriod.cs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
namespace GeneGenie.Gedcom.Enums
{
/// <summary>
/// How accurate is the date and what range does it span?.
/// How accurate is the date and what range does it span?
/// </summary>
public enum GedcomDatePeriod
{
Expand Down
10 changes: 5 additions & 5 deletions GeneGenie.Gedcom/Enums/GedcomErrorState.cs
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ public enum GedcomErrorState
LevelExpected,

/// <summary>
/// Delimeter after level not found
/// Delimiter after level not found
/// </summary>
LevelMissingDelim,

Expand All @@ -33,7 +33,7 @@ public enum GedcomErrorState
LevelInvalid,

/// <summary>
/// Delimeter after XrefID not found
/// Delimiter after XrefID not found
/// </summary>
XrefIDMissingDelim,

Expand All @@ -48,7 +48,7 @@ public enum GedcomErrorState
TagExpected,

/// <summary>
/// Delimeter, or newline after the tag was not found
/// Delimiter, or newline after the tag was not found
/// </summary>
TagMissingDelimOrTerm,

Expand All @@ -58,7 +58,7 @@ public enum GedcomErrorState
LineValueExpected,

/// <summary>
/// newline after line value not found
/// Newline after line value not found
/// </summary>
LineValueMissingTerm,

Expand All @@ -68,7 +68,7 @@ public enum GedcomErrorState
LineValueInvalid,

/// <summary>
/// Deliminator in GEDCOM is a single space, this error will occur
/// Delimiter in GEDCOM is a single space, this error will occur
/// when a multi space delimiter is detected
/// </summary>
InvalidDelim,
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/GedcomAssociation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ namespace GeneGenie.Gedcom

/// <summary>
/// How the given individual is associated to another.
/// Each GedcomIndividal contains a list of these.
/// Each GedcomIndividual contains a list of these.
/// </summary>
public class GedcomAssociation : GedcomRecord, IComparable, IComparable<GedcomAssociation>, IEquatable<GedcomAssociation>
{
Expand Down
6 changes: 3 additions & 3 deletions GeneGenie.Gedcom/GedcomEvent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public class GedcomEvent : GedcomRecord, IComparable, IComparable<GedcomEvent>,
"SSN",
"TITL",

// GEDCOM allows custom records, beginging with _
// GEDCOM allows custom records, beginning with _
"_UNKN",
};

Expand Down Expand Up @@ -757,7 +757,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant husband");
System.Diagnostics.Debug.WriteLine("Pointer to non existent husband");
}
}

Expand Down Expand Up @@ -785,7 +785,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant wife");
System.Diagnostics.Debug.WriteLine("Pointer to non existent wife");
}
}

Expand Down
6 changes: 3 additions & 3 deletions GeneGenie.Gedcom/GedcomFamilyLink.cs
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ namespace GeneGenie.Gedcom
using GeneGenie.Gedcom.Enums;

/// <summary>
/// How an individal is linked to a family.
/// How an individual is linked to a family.
/// </summary>
public class GedcomFamilyLink : GedcomRecord, IComparable<GedcomFamilyLink>, IComparable, IEquatable<GedcomFamilyLink>
{
Expand Down Expand Up @@ -183,10 +183,10 @@ public ChildLinkageStatus Status
}

/// <summary>
/// Gets or sets a value indicating whether [prefered spouse].
/// Gets or sets a value indicating whether [preferred spouse].
/// </summary>
/// <value>
/// <c>true</c> if [prefered spouse]; otherwise, <c>false</c>.
/// <c>true</c> if [preferred spouse]; otherwise, <c>false</c>.
/// </value>
public bool PreferedSpouse
{
Expand Down
6 changes: 3 additions & 3 deletions GeneGenie.Gedcom/GedcomFamilyRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -910,7 +910,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant husband");
System.Diagnostics.Debug.WriteLine("Pointer to non existent husband");
}
}

Expand All @@ -937,7 +937,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant wife");
System.Diagnostics.Debug.WriteLine("Pointer to non existent wife");
}
}

Expand Down Expand Up @@ -1016,7 +1016,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant child");
System.Diagnostics.Debug.WriteLine("Pointer to non existent child");
}
}

Expand Down
6 changes: 3 additions & 3 deletions GeneGenie.Gedcom/GedcomIndividualRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
private GedcomRecordList<GedcomIndividualEvent> attributes;

// TODO
private object lDSIndividualOrdinances;

Check warning on line 34 in GeneGenie.Gedcom/GedcomIndividualRecord.cs

View workflow job for this annotation

GitHub Actions / Analyze (csharp)

The field 'GedcomIndividualRecord.lDSIndividualOrdinances' is never used

Check warning on line 34 in GeneGenie.Gedcom/GedcomIndividualRecord.cs

View workflow job for this annotation

GitHub Actions / Build and analyze

The field 'GedcomIndividualRecord.lDSIndividualOrdinances' is never used

private GedcomRecordList<GedcomFamilyLink> childIn;
private GedcomRecordList<GedcomFamilyLink> spouseIn;
Expand Down Expand Up @@ -899,7 +899,7 @@
}

/// <summary>
/// Sets the name of the prefered.
/// Sets the name of the preferred.
/// </summary>
/// <param name="name">The name.</param>
public void SetPreferedName(GedcomName name)
Expand Down Expand Up @@ -1002,7 +1002,7 @@

GedcomFamilyLink link = SpouseIn.FirstOrDefault(f => (f.PreferedSpouse == true));

// shouldn't need this as we automatically set the prefered on loading
// shouldn't need this as we automatically set the preferred on loading
// do the check anyway though just incase.
if (link == null && SpouseIn.Count > 0)
{
Expand Down Expand Up @@ -1367,7 +1367,7 @@
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant associated individual");
System.Diagnostics.Debug.WriteLine("Pointer to non existent associated individual");
}
}

Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/GedcomRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -465,7 +465,7 @@ public void GenerateNoteXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant note");
System.Diagnostics.Debug.WriteLine("Pointer to non existent note");
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/GedcomSourceCitation.cs
Original file line number Diff line number Diff line change
Expand Up @@ -273,7 +273,7 @@ public override void GenerateXML(XmlNode root)
}
else
{
System.Diagnostics.Debug.WriteLine("Pointer to non existant source");
System.Diagnostics.Debug.WriteLine("Pointer to non existent source");
}

if (!string.IsNullOrEmpty(Page))
Expand Down
2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/GedcomSourceRecord.cs
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public GedcomSourceRecord(GedcomDatabase database)
public StringBuilder PublicationText { get; set; }

/// <summary>
/// Gets or sets the text text. TODO: What?.
/// Gets or sets the text text. TODO: What?
/// </summary>
public StringBuilder TextText { get; set; }

Expand Down
26 changes: 13 additions & 13 deletions GeneGenie.Gedcom/GeneGenie.Gedcom.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion GeneGenie.Gedcom/Helpers/EnumHelper.cs
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ public static T ParseByDescription<T>(string value, bool ignoreCase, T defaultVa
}

/// <summary>
/// Outputs a string version of an enum by using the <see cref="DescriptionAttribute"/> attribute.
/// Outputs a string version of an enum by using the <see cref="DescriptionAttribute"/> attribute.
/// Fails over to the enum name if the <see cref="DescriptionAttribute"/> does not exist.
/// </summary>
/// <param name="e">The enum to output.</param>
Expand Down
6 changes: 3 additions & 3 deletions GeneGenie.Gedcom/Parser/GedcomParser.cs
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ namespace GeneGenie.Gedcom.Parser
/// </summary>
public class GedcomParser
{
// arbitary magic max level number
// arbitrary magic max level number
private const int MaxLevel = 99;
private const int MaxXRefLength = 22;

Expand Down Expand Up @@ -186,7 +186,7 @@ public GedcomErrorState GedcomParse(string data)

// Tags are always the same, data.Substring was allocating lots
// of memory, instead use a special collection which matches via
// array index, e.g tagCollection[str, index, length] to avoid
// array index, e.g. tagCollection[str, index, length] to avoid
// the extra allocations, and caches the resulting string for
// use again without having to substring
if (TagCollection == null)
Expand Down Expand Up @@ -503,7 +503,7 @@ public GedcomErrorState GedcomParse(string data)

// TODO: no line value, but have hit the terminator
// what should this be allowed for?
// Family Tree Maker outputs emtpy CONT (and CONC?)
// Family Tree Maker outputs empty CONT (and CONC?)
else if (Tag == "CONT" || Tag == "CONC")
{
LineValue = " ";
Expand Down
Loading
Loading