[Phase 5] API Documentation (Issue #45)#62
Merged
gmajor-encrypt merged 1 commit intomasterfrom Mar 25, 2026
Merged
Conversation
- Add phpdoc.xml configuration - Add docs/API.md (API overview, usage examples) - Add docs/TYPES.md (detailed types reference) - Update Makefile with make docs target Closes #45
gmajor-encrypt
force-pushed
the
feature/api-documentation
branch
from
1d35e39 to
f50d6be
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR adds API documentation generation for php-scale-codec.
Files Added
phpdoc.xml: phpDocumentor configurationdocs/API.md: API overview and examplesdocs/TYPES.md: Detailed types referenceMakefile
Added
make docstarget:Runs phpDocumentor to generate the API documentation in
docs/api.Tasks from Issue #45
phpDocumentor)Closes #45