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.

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

XML documentation report #125

Open
Jericho opened this issue Oct 24, 2020 · 2 comments
Open

XML documentation report #125

Jericho opened this issue Oct 24, 2020 · 2 comments
Assignees
Labels
enhancement New feature or request

Comments

@Jericho
Copy link
Member

Jericho commented Oct 24, 2020

Analyze XML documentation included with each addin and generate a report to suggest improvements.

See cake-build/website#318 for details

@Jericho Jericho added the enhancement New feature or request label Oct 24, 2020
@Jericho Jericho added this to the 3.53.0 milestone Oct 24, 2020
@Jericho Jericho self-assigned this Oct 24, 2020
@Jericho
Copy link
Member Author

Jericho commented Oct 24, 2020

Slowly but surely making progress. I can now generate a report that looks like this:

image

However, I am now facing a problem that I had previously avoided:

image

Most likely these exceptions are due to decorated methods that return a type which is defined in a different assembly than the one being analyzed. I had previously avoided this issue by carefully ensuring I did not cause types to be instantiated: https://github.com/cake-contrib/Cake.AddinDiscoverer/blob/develop/Source/Cake.AddinDiscoverer/Steps/AnalyzeNuGetMetadataStep.cs#L345

I will have to investigate how I can avoid types to be instantiated in my XML documentation analysis code.

@Jericho Jericho modified the milestones: 3.53.0, 3.54.0, 3.55.0 Oct 26, 2020
@Jericho
Copy link
Member Author

Jericho commented Dec 2, 2020

Following Skype call with @pascalberger, we agreed that AddinDiscoverer will analyze as many addins as possible and will output a message such as "We were unable to analyse the XML documentation for this addin because ..." if there are any issues related to not being able to load a dependent assembly, or any other problem.

@Jericho Jericho modified the milestones: 3.57.0, 3.58.0, 3.59.0 Dec 2, 2020
@Jericho Jericho modified the milestones: 3.59.0, 3.60.0, 3.61.0, 3.62.0 Dec 12, 2020
@Jericho Jericho modified the milestones: 3.62.0, 3.63.0 Dec 23, 2020
@Jericho Jericho removed this from the 3.65.0 milestone Feb 7, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant