Add Docstrings to Classes and Methods

[sweep-ai[bot]]

PR Feedback (click)

• [ ] 👍 Sweep Did Well
• [ ] 👎 Sweep Needs Improvement

  I created this PR to address this rule:

  "Add docstrings to all functions and file headers."

  Description

  This PR adds docstrings to several classes and methods in the Laravel Gedcom project. The docstrings provide a clear understanding of the purpose, functionality, and usage of the classes and methods. They follow the PHPDoc standards, including a brief description of the class or method, parameters (if any), and return types.

The files modified in this PR are:

• src/Utils/GedcomParser.php
• src/Utils/Importer/FamilyParser.php
• src/Utils/Importer/IndividualParser.php
• src/Utils/Importer/MediaParser.php
• src/Utils/ProgressReporter.php

Summary of Changes

• Added file-level docstrings at the beginning of each file, describing the purpose of the file.
• Added class-level docstrings for each class, describing the purpose of the class.
• Added method-level docstrings for each public method, describing the purpose of the method, its parameters (with types), and its return types (if applicable).
• No changes were made to the actual code logic, only comments were added.

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to src/Utils/GedcomParser.php
• [ ] Rollback changes to src/Utils/GedcomParser.php
• [ ] Rollback changes to src/Utils/Importer/FamilyParser.php
• [ ] Rollback changes to src/Utils/Importer/FamilyParser.php
• [ ] Rollback changes to src/Utils/Importer/IndividualParser.php
• [ ] Rollback changes to src/Utils/Importer/IndividualParser.php
• [ ] Rollback changes to src/Utils/Importer/MediaParser.php
• [ ] Rollback changes to src/Utils/Importer/MediaParser.php
• [ ] Rollback changes to src/Utils/ProgressReporter.php
• [ ] Rollback changes to src/Utils/ProgressReporter.php