Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add STL-Specific Code Analyzer Package For Documenting Class Constructors #206

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open

Add STL-Specific Code Analyzer Package For Documenting Class Constructors #206

wants to merge 15 commits into from

Conversation

Shalini-Subramanian
Copy link
Collaborator

@Shalini-Subramanian Shalini-Subramanian commented Feb 12, 2025 •
edited by Mattjet27
Loading

What does this Pull Request accomplish?

  • Integrated the analyzer through the NuGet package.
  • Added packages folder to repository and included NuGet package.
  • Added nuget.config to fetch the NuGet package from within the solution files.
  • Added package reference to each CSProject file to reference the NuGet package.

Why should this Pull Request be merged?

Whenever a class does not contain at least one constructor, its documentation will not be visible to the user when an instance is created. Currently, this is validated manually. In this PR, I have addressed this issue by using a NuGet package with an analyzer created in the previous to detect missing class constructors.

What testing has been done?

  • Error popped up and added the required fixes to address the missing of the constructor.

Shalini-Subramanian and others added 2 commits February 6, 2025 08:11
@Shalini-Subramanian
feat:Include nuget packages
b712c81 
Signed-off-by: Shalini-Subramanian <[email protected]>
feat: Update constructors and unit tests
c5c3d12 
Signed-off-by: Shalini Subramanian <[email protected]>
feat: Update unit tests
41a264c 
Signed-off-by: Shalini Subramanian <[email protected]>
fix: Update PR comments
6caaf19 
Signed-off-by: Shalini Subramanian <[email protected]>
@Shalini-Subramanian Shalini-Subramanian marked this pull request as ready for review February 13, 2025 06:15
Shalini-Subramanian
Shalini-Subramanian commented Feb 13, 2025
View reviewed changes
Mattjet27
Mattjet27 requested changes Feb 13, 2025
View reviewed changes
fix: Resolve PR comments
2f9faf4 
Signed-off-by: Shalini Subramanian <[email protected]>
Mattjet27
Mattjet27 approved these changes Feb 17, 2025
View reviewed changes
@Mattjet27 Mattjet27 changed the title Add nuget packages and update the classes Add STL-Specific Code Analyzer Package For Documenting Class Constructors Feb 17, 2025
@Mattjet27 Mattjet27 enabled auto-merge (squash) February 17, 2025 11:17
@Shalini-Subramanian
fix: Update nuget package
af8eb95 
Signed-off-by: Shalini-Subramanian <[email protected]>
@Shalini-Subramanian
fix: Update sdk version
a47dfce 
Signed-off-by: Shalini-Subramanian <[email protected]>
@Shalini-Subramanian
fix: Add NuGet changes
0d5251d 
Signed-off-by: Shalini-Subramanian <[email protected]>
@Shalini-Subramanian
fix: Update NuGet packages
b5dcf5f 
Signed-off-by: Shalini-Subramanian <[email protected]>
@Mattjet27 Mattjet27 disabled auto-merge February 19, 2025 12:53
@Shalini-Subramanian
fix: Update nuget package
20d94f0 
Signed-off-by: Shalini-Subramanian <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Mattjet27 Mattjet27 Mattjet27 approved these changes

@lornazh lornazh lornazh approved these changes

@ni-ramya ni-ramya Awaiting requested review from ni-ramya

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@Shalini-Subramanian @Mattjet27 @lornazh