Add Missing Docstrings in src/FormatInformation.php and src/Writer.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 the issue of missing docstrings in two files: src/FormatInformation.php and src/Writer.php. The docstrings have been added following the PHPDoc format to provide clear and concise documentation for the functions and the overall files.

In src/FormatInformation.php, a header docstring has been added to describe the overall purpose of the file. Additionally, a docstring for the addFormatInformation function has been added to explain its purpose, parameters, and return value.

In src/Writer.php, the convert function has been updated with a new docstring that outlines the function's purpose, parameters, and any changes in behavior due to recent updates.

Summary of Changes

• Added a header docstring in src/FormatInformation.php to describe the file's purpose.
• Added a docstring for the addFormatInformation function in src/FormatInformation.php to detail its purpose, parameters, and return value.
• Updated the convert function in src/Writer.php with a new docstring that explains its purpose, parameters, and changes in behavior.

These changes will help other developers understand the purpose and usage of these functions and the files as a whole, making the code easier to maintain and update in the future.

[sweep-ai[bot]]

Rollback Files For Sweep

• [ ] Rollback changes to src/FormatInformation.php
• [ ] Rollback changes to src/FormatInformation.php
• [ ] Rollback changes to src/Writer.php
• [ ] Rollback changes to src/Writer.php