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

MemArena: Cleanup & interface changes for safer memory mapping. #10277

Merged
merged 2 commits into from Dec 30, 2021

Conversation

AdmiralCurtiss
Copy link
Contributor

@AdmiralCurtiss AdmiralCurtiss commented Dec 14, 2021

See #9544 and #9834.

Note that there are no functional changes in this PR. (or should be, anyway)

// CreateView() and ReleaseView(). This is used to make a mappable region for emulated memory.
//
// Parameters:
// - 'size' is the amount of bytes that should be allocated in this region.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may want to turn these comments into doxygen style comments with /// or /** and use @param here

clang has a -Wdocumentation warning level that can flag anything if the parameter names change in the future through refactoring and the comment falls out of sync

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I matched it to the format used in BitUtils.h, I assume that's good?

@JMC47 JMC47 merged commit 1c8a7f1 into dolphin-emu:master Dec 30, 2021
10 checks passed
@AdmiralCurtiss AdmiralCurtiss deleted the memarena-cleanup branch December 30, 2021 00:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
4 participants