[TASK] Drop the configuration for generating the API documentation #516
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
oliverklee
added this to the 9.0.0: Drop support for PHP < 7.2 and clean up things milestone
oliverklee
force-pushed
the
task/drop-class-documentation
branch
from
582c913
to
198aa7f
Compare
JakeQZ
reviewed
Mar 5, 2024
There was a problem hiding this comment.
The title of this PR seems to be wrong. Isn't it the configuration for generating HTML documentation (with Doxygen) that's being removed?
I don't know whether or how it's actively being used. However, having navigable HTML could still be useful in some situations:
- if the library was compiled into a PHAR, the PHPDoc wouldn't be available;
- when considering using the library, without having yet installed it, being able to browse the HTML documention could be helpful.
So I am not sure about removing this. Also, does keeping it cause any problem? I think it is should not exist in the package installed as a dependency via Composer (because it would just waste disk space there) - is that already taken care of?
oliverklee
changed the title
oliverklee
changed the title
Now that IDEs support navigating and displaying PHPDoc comments reasonibly well, and now that we have a UML class diagram, rendering the PHPDoc does not provide relevant benefits anymore. Part of #466
oliverklee
force-pushed
the
task/drop-class-documentation
branch
from
198aa7f
to
789bec0
Compare
|
Moving the discussion to #520. |
|
Closing in favor of #522. |
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.
Now that IDEs support navigating and displaying PHPDoc comments reasonibly well, and now that we have a UML class diagram, rendering the PHPDoc does not provide relevant benefits anymore.
Part of #466