Use PHPDoc for Task & Transformer Reference #125
Closed
Conversation
This file contains 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
added 5 commits
September 17, 2021 17:25
2 tasks
|
Too much changes between proposal and main branch => So moved to #159 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
Today, reference documentation is lacking a lot of information, and some might be quickly obsolete...
The goal of this PR is to put a maximum of documentation right into PHPDoc
I tried to use https://phpdoc.org/ to generate a static website to help peeking into content.
There's still on-going documentation work. Some customization has been added in the
.phpdocfolderRequirements
.mdfileCookbooksChangelogUnit testsImplementation notes
To build the doc, use
make build/sf4 docBreaking changes
None