Improve Documentation #5
Assignees
Labels
documentation
Improvements or additions to documentation
Comments
NorthernSeaCharting
added
the
documentation
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 17, 2020
…ve the config path determination, the documentation and the adherence to Symfony's coding guidelines). Markdown: - CHANGELOG-3.x.md: Added the new improvement introduced by this commit. PHP: - ConfigPathUtility.php 1. Improved config path retrieval: This was done in order catch more configuration files especially of the bundles, this new way is now less reliant on the strict adherence to Symfony's recommended bundle structure. 2. Refactored the code to adhere more closely to Symfony's recommended coding style. - CustomContainerBuilder.php: 1. Added and refactored documentation for functions and methods within the Container Builder in order to improve readability of the class and its methods. - CustomDelegatingLoader.php: Also small refactorings to the documentation for improved readability. - CustomGlobLoader.php: Same as before, more small refactorings to the documentation for better readability. - CustomValueStorage.php: Refactorings of the code and the documentation to be more inline with the Symfony coding guidelines and also to improve readability. - LoadInitializer.php: Added and refactored documentation for more readability and clarity on the class. - LocationAwareParameterBag.php: Added documentation and refactored the existing code to be more inline with the aforementioned guidelines and for more clarity on the class and its methods. - LocationRetrievalCoordinator.php: Also added and refactored the existing documentation with the same thinking as before. - Utility.php: Added documentation on every function and the class and also refactored the functions a bit, for more information on the class and its methods.
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 17, 2020
…ve the config path determination, the documentation and the adherence to Symfony's coding guidelines). Markdown: - CHANGELOG-2.x.md: Added the new improvement introduced by this commit. - README.md: Missing feature "Location Retrieval" entered back into README, since the feature does now work again PHP: - ConfigPathUtility.php 1. Improved config path retrieval: This was done in order catch more configuration files especially of the bundles, this new way is now less reliant on the strict adherence to Symfony's recommended bundle structure. 2. Refactored the code to adhere more closely to Symfony's recommended coding style. - CustomContainerBuilder.php: 1. Added and refactored documentation for functions and methods within the Container Builder in order to improve readability of the class and its methods. - CustomDelegatingLoader.php: Also small refactorings to the documentation for improved readability. - CustomValueStorage.php: Refactorings of the code and the documentation to be more inline with the Symfony coding guidelines and also to improve readability. - LoadInitializer.php: Added and refactored documentation for more readability and clarity on the class. - LocationAwareParameterBag.php: Added documentation and refactored the existing code to be more inline with the aforementioned guidelines and for more clarity on the class and its methods. - LocationRetrievalCoordinator.php: Also added and refactored the existing documentation with the same thinking as before. - Utility.php: Added documentation on every function and the class and also refactored the functions a bit, for more information on the class and its methods.
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 18, 2020
No in depth comments on every class, since no real code changes have occurred. The biggest changes include removing all scalar type hints from method signatures (since these do not seem to be present in 7.1) and adding documentation to every class. The documentation includes descriptions of methods, attributes and the class itself. Also the coding style was brought more inline with Symfony's coding standards. All of this was done to lower the requirements for the bundle and make the code more understandable and readable.
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 18, 2020
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 18, 2020
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 21, 2020
…atform 2.5 version) for issues #5, #6 and #4 - Added or improved documentation for every php class of the bundle - Refactored code for every function and class of the bundle to fit Symfony's coding style more - In ConfigProcessController.php and routing.yaml for parameter list file download changed the parameter name from "downloadDenominator" to "downloadDescriptor" so it is more clear what the parameter does - Improved ParametersToFileWriter.php and added checks and editions for special character within keys and also values in order to improve the file representation and keep the output valid yaml (there will hopefully soon be even more improvements to the functionality)
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 22, 2020
- CHANGELOG-3.x.md: Added more information on changes made - ConfigProcessLocationInfoController.php: Fixed a small issue where paths which did not feature the project directory or were in a different path under a similar directory, would be needlessly cut, leading to false paths. - ParametersToFileWriter.php: Added more documentation and removed a redundant symbol of a regex to improve functionality and clarity of the code.
NorthernSeaCharting
pushed a commit
that referenced
this issue
Dec 22, 2020
…eived prior with updates to #4 and #5 - ConfigProcessController.php: Just as with the main branch, renamed a parameter from "downloadDenominator" to "downloadDescriptor" so it is more clear what its purpose is. - ConfigProcessLocationInfoController.php: Just as with the 3.x version, fixed an issue where locations for parameters would be edited poorly due to them residing outside the plain project structure - ParametersToFileWriter.php: Added documentation and caught issues with special characters being used as keys or within values and escaped these for more valid and proper yaml
NorthernSeaCharting
pushed a commit
that referenced
this issue
Jan 6, 2021
PHP: - ProcessedConfigOutputCommand.php: Added this new console command to enable the processed config to also be accessed via the console and not only the frontend of the bundle - ConfigProcessController.php: Added the environmental parameters view route and controller action and fixed bug with the bundle config not working properly, when the favourites feature was turned off - CJWConfigProcessorExtension.php and Configuration.php: Added new configuration for the environmental variable display - LeftSideBarMenuBuilder.php: Added new left sidebar button to access the dedicated env view - CustomParamProcessor.php: Added setter for the active site accesses to filter for to allow more dynamic work with the processor Config: - routing.yaml and services.yml: Added the env view as route and the console command as a service Documentation: Updates to the documentation across the board for more readability and more detailed information. Also added documentation for the new view CSS: - parameter_display.css: Small tweak for better display of inline values Twig: - param_view_environment.html.twig: Added dedicated template for env parameters view
NorthernSeaCharting
added a commit
that referenced
this issue
Jan 7, 2021
PHP: - ConfigLocationOutputCommand.php: Added Symfony console command to display the configuration paths (as determined by the bundle) of the parameters. - ProcessedConfigOutputCommand.php: Added styling to the command output to provide more information and feedback to the user and updated its documentation. - ConfigProcessController.php: Removed unnecessary comments from the controller. - CJWConfigProcessorExtension.php: Modified config so that the environmental variables are turned on by default. - CustomParamProcessor.php: Small documentation fix. Config: - services.yml: Added new console command as Symfony service.
NorthernSeaCharting
added a commit
that referenced
this issue
Jan 7, 2021
…o the 3.x version: Commit concerns issues #5 and #6 ,#8 and #9 PHP: - ConfigLocationOutputCommand.php: Added Symfony console command to display the configuration paths (as determined by the bundle) of the parameters. - ProcessedConfigOutputCommand.php: Added styling to the command output to provide more information and feedback to the user and updated its documentation. - ConfigProcessController.php: Removed unnecessary comments from the controller. - CJWConfigProcessorExtension.php: Modified config so that the environmental variables are turned on by default. - CustomParamProcessor.php: Small documentation fix. Config: - services.yml: Added new console command as Symfony service. And the other commit: PHP: - ProcessedConfigOutputCommand.php: Added this new console command to enable the processed config to also be accessed via the console and not only the frontend of the bundle - ConfigProcessController.php: Added the environmental parameters view route and controller action and fixed bug with the bundle config not working properly, when the favourites feature was turned off - CJWConfigProcessorExtension.php and Configuration.php: Added new configuration for the environmental variable display - LeftSideBarMenuBuilder.php: Added new left sidebar button to access the dedicated env view - CustomParamProcessor.php: Added setter for the active site accesses to filter for to allow more dynamic work with the processor Config: - routing.yaml and services.yml: Added the env view as route and the console command as a service Documentation: Updates to the documentation across the board for more readability and more detailed information. Also added documentation for the new view CSS: - parameter_display.css: Small tweak for better display of inline values Twig: - param_view_environment.html.twig: Added dedicated template for env parameters view
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
As with any code, there are still a lot of classes and functions which lack sufficient documentation:
Add documentation for:
Backend
Frontend
The text was updated successfully, but these errors were encountered: