Align the output of docgen.php to gen_stub.php #86
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
kocsismate
force-pushed
the
sync-stub
branch
from
3a0cb7b
to
67337cc
Compare
Girgias
reviewed
Dec 18, 2022
| @@ -606,7 +609,7 @@ function gen_class_markup(ReflectionClass $class, $content) { /* {{{ */ | |||
| } | |||
| $markup .= '<classsynopsisinfo role="comment">&InheritedProperties;</classsynopsisinfo>'. PHP_EOL; | |||
| foreach ($inherited as $declaring_class) { | |||
| $markup .= str_repeat(' ', $ident) ."<xi:include xpointer=\"xmlns(db=http://docbook.org/ns/docbook) xpointer(id('" . strtolower($declaring_class) . ".synopsis')/descendant::db:fieldsynopsis)\"><xi:fallback/></xi:include>". PHP_EOL; | |||
| $markup .= str_repeat(' ', $ident) ."<xi:include xpointer=\"xmlns(db=http://docbook.org/ns/docbook) xpointer(id('" . strtolower($declaring_class) . ".synopsis')/descendant::db:fieldsynopsis)\">" . PHP_EOL . str_repeat(' ', $ident + 1) . "<xi:fallback/>" . PHP_EOL . str_repeat(' ', $ident) . "</xi:include>". PHP_EOL; | |||
There was a problem hiding this comment.
Wouldn't it be better to use "\n" instead of PHP_EOL? As the output on Windows will be different from Nix
There was a problem hiding this comment.
Yeah, I was thinking about changing this, but at last I decided not to touch so many instances of PHP_EOL (150+). However, this could de addressed in a separate PR if Christoph also agrees.
There was a problem hiding this comment.
Right makes sense to leave it as is then
Girgias
approved these changes
Aug 2, 2023
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.
I only fixed a few things, but then realized that it's not possible to completely align the output of the two scripts, since gen_stub.php has much more information about symbols than docgen.php has (like the
@readonlyor@typePHPDoc).