Drop file pages emptied by the @ignore tag (FileAssembler)#4110
Open
lacatoire wants to merge 2 commits into
Open
Drop file pages emptied by the @ignore tag (FileAssembler)#4110lacatoire wants to merge 2 commits into
lacatoire wants to merge 2 commits into
Conversation
When every class, interface, trait, enum, function or constant of a file is removed by a descriptor filter (for example because each carries an @ignore tag) the FileAssembler now returns null. Without this change the file page was still generated, listed in the files index and exposed the full source, which defeated the purpose of @ignore for users relying on it to hide entire entities. Refs phpDocumentor#1959
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.
When every class, interface, trait, enum, function or constant of a file is removed by a descriptor filter (typically because each element carries an
@ignoretag) the file page was still generated, listed in the files index and exposed the full source, which defeated the purpose of@ignore.FileAssemblernow returnsnullin that case, mirroring how the class page itself is already omitted.Refs #1959