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

Add support for parsing documentation comments on declarations #1002

Merged
merged 4 commits into from
Dec 9, 2021

Conversation

cobbal
Copy link
Contributor

@cobbal cobbal commented Oct 21, 2021

As mentioned in #766

@krzysztofzablocki
Copy link
Owner

I'll do a proper review on the weekend but I imagine this can have pretty significant impact on performance of tens of thousands of apps that don't really use this feature, I'm ok including this if we make it opt-in behind configuration flag but off by default

would you mind adding that? If its not enabled just default to empty comment info

@cobbal
Copy link
Contributor Author

cobbal commented Oct 22, 2021

I put the flag in. It touched a lot of places though; there might be a cleaner way to do it.

@cobbal
Copy link
Contributor Author

cobbal commented Nov 10, 2021

@krzysztofzablocki Any update on this?

@krzysztofzablocki
Copy link
Owner

I'll get on this soon, started new job last week so been quite busy

@cobbal
Copy link
Contributor Author

cobbal commented Nov 12, 2021

I'll get on this soon, started new job last week so been quite busy

Congrats! I understand that. It's not a rush, but I just wanted to make sure it was moving along :) And thank you for all you do for this project :)

@krzysztofzablocki krzysztofzablocki merged commit 36adeac into krzysztofzablocki:master Dec 9, 2021
@mhdhejazi
Copy link

Thank you @cobbal and @krzysztofzablocki for this great feature!

I'm not able to get Sourcery to parse documentation unless I pass --disableCache. I just wanted to confirm that this is the expected behaviour.

Also, it'd be great if Sourcery docs are also updated to mention the new documentation property.

@krzysztofzablocki
Copy link
Owner

krzysztofzablocki commented Mar 6, 2022

@mhdhejazi have you tried nuking old cache manually? try removing the cache and then it will re-create it on next run, let me know if you are still running into issue without disableCache after doing so

Cache is under ~/Library/Caches/Sourcery

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants