Add Docstrings to Functions and File Header in GedcomExporterHelpers.php

[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 issue #, which pointed out the lack of docstrings in the src/Commands/GedcomExporterHelpers.php file. To adhere to our coding standards and improve code readability, docstrings have been added to each function and at the file header following the PHPDoc standards.

Summary of Changes

• Added a file header docstring in src/Commands/GedcomExporterHelpers.php explaining the purpose of the file.
• Added docstrings for the createDirectory function, explaining its purpose and parameter.
• Added docstrings for the fetchDatabaseData function, explaining its purpose and return type.
• Added docstrings for the prepareDataForView function, explaining its purpose, parameters, and return type.
• Added docstrings for the createGedcomDocumentString function, explaining its purpose, parameter, and return type.
• Added docstrings for the writeToFile function, explaining its purpose and parameters.

These changes enhance the readability and maintainability of the code by providing clear descriptions of the file's purpose and the functionality of each method within it.

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php
• [ ] Rollback changes to src/Commands/GedcomExporterHelpers.php