Add Docstrings to Improve Code Documentation

[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 addresses the issue of missing docstrings in the php-gedcom project. Docstrings have been added to the files and their respective functions and classes to improve code readability and maintainability. The changes were made in the following files:

• src/Models/RecordInterface.php

• src/Parser.php

• src/Parser/Interfaces/ParserInterface.php

• src/Record.php

• src/Utils/DataOptimizer.php

• src/Parser/Sour.php (Assuming this was the intended file as src/Writer/Sour.php was not found)

Each docstring provides a brief summary of what the function or class does, improving the understanding of the codebase for current and future developers.

Summary of Changes

• Added docstrings to the RecordInterface interface and its methods in src/Models/RecordInterface.php.
• Added docstrings to the Parser class and its methods in src/Parser.php.
• Added docstrings to the ParserInterface interface and its methods in src/Parser/Interfaces/ParserInterface.php.
• Added docstrings to the Record abstract class and its methods in src/Record.php.
• Added docstrings to the DataOptimizer class and its methods in src/Utils/DataOptimizer.php.
• Added docstrings to the Sour class and its methods in src/Parser/Sour.php (assuming this was the intended file).

These changes enhance the documentation within the codebase, making it more accessible and easier to work with for developers.

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to src/Models/RecordInterface.php
• [ ] Rollback changes to src/Models/RecordInterface.php
• [ ] Rollback changes to src/Parser.php
• [ ] Rollback changes to src/Parser.php
• [ ] Rollback changes to src/Parser/Interfaces/ParserInterface.php
• [ ] Rollback changes to src/Parser/Interfaces/ParserInterface.php
• [ ] Rollback changes to src/Record.php
• [ ] Rollback changes to src/Record.php
• [ ] Rollback changes to src/Utils/DataOptimizer.php
• [ ] Rollback changes to src/Utils/DataOptimizer.php
• [ ] Rollback changes to src/Parser/Sour.php
• [ ] Rollback changes to src/Parser/Sour.php