Refactor all compilers to work on a DocumentationSet #3492
Merged
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
Since the compilers work on files and indexes on a DocumentationSet, the entirety of them should really interact with a DocumentationSet and not a project
jaapio
reviewed
Mar 24, 2023
| { | ||
| $this->analyzer->analyze($project); | ||
| $this->analyzer->analyze($documentationSet); |
There was a problem hiding this comment.
The analyzer itself does varying things depending on the type of documentation set
I have explicitly not added these and tried to keep it as generic as possible. At the moment, guides do not use files and indexes; but I would love to have this a generic mechanism across all Documentation Sets. At this point, because only API Sets populate these indexes, I have limited the checks on API Sets only where it really is about API Sets. You can find a few of these in the compiler passes themselves |
When building documentation, the elements offset is required and as such I have moved the initialization to the front of the compiler. A question could be whether this is really needed, but I have postponed that question for later; so that the effort to support Documentation Sets progresses.
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.
Since the compilers work on files and indexes on a DocumentationSet, the entirety of them should really interact with a DocumentationSet and not a project