feat(compiler): extract docs for top level functions and consts#51713
Closed
jelbourn wants to merge 5 commits intoangular:mainfrom
Closed
feat(compiler): extract docs for top level functions and consts#51713jelbourn wants to merge 5 commits intoangular:mainfrom
jelbourn wants to merge 5 commits intoangular:mainfrom
Conversation
This commit adds a barebones skeleton for extracting information to be used for extracting info that can be used for API reference generation. Subsequent PRs will expand on this with increasingly real extraction. I started with @alxhub's angular#51615 and very slightly polished to get to this minimal commit.
Based on top of angular#51682 This expands on the skeleton previously added to extract docs info for classes, including properties, methods, and method parameters. Type information and Angular-specific info (e.g. inputs) will come in future PRs.
Based on top of angular#51685 This expands on the extraction with information for directives, including inputs and outputs. As part of this change, I've refactored the extraction code related to class and to directives into their own extractor classes to more cleanly separate extraction logic based on type of statement.
Based on top of angular#51697 Adds extraction for accessors (getters/setters), rest params, and resolved type info for everything so far. This also refactors function extraction into a new class and splits tests for common class info and directive info into separate files.
Based on top of #angular#51700 Also updates extraction to ignore un-exported statements.
d0743ef to
77ac4f5
Compare
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 10, 2023
Based on top of angular#51713 This commit adds docs extraction for information provided in JsDoc comments, including descriptions and Jsdoc tags.
jelbourn
added a commit
to jelbourn/angular
that referenced
this pull request
Sep 15, 2023
Based on top of angular#51713 This commit adds docs extraction for information provided in JsDoc comments, including descriptions and Jsdoc tags.
pkozlowski-opensource
pushed a commit
that referenced
this pull request
Sep 18, 2023
Contributor
Author
|
Changes merged in #51733 |
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
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 subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
Based on top of ##51700
Also updates extraction to ignore un-exported statements.