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

[pydocs] Add warning to ControlList().reset() regarding ListItem destruction #15782

Merged
merged 1 commit into from Mar 21, 2019

Conversation

Projects
None yet
3 participants
@enen92
Copy link
Member

commented Mar 20, 2019

Description

When ControlList.addItems() is called after ControlList.reset() there's a high likelihood that the items are not valid anymore since reset() will attempt to destroy the items if not referenced from elsewhere (resulting in a crash). This PR adds this warning to the method documentation and provides an example on how to avoid the items destruction (by storing them as member variables of the WindowXMLDialog class.

Motivation and Context

#15750

How Has This Been Tested?

Compiled docs and see output

Screenshots (if appropriate):

docs

Types of change

  • Bug fix (non-breaking change which fixes an issue)
  • Clean up (non-breaking change which removes non-working, unmaintained functionality)
  • Improvement (non-breaking change which improves existing functionality)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that will cause existing functionality to change)
  • Cosmetic change (non-breaking change that doesn't touch code)
  • None of the above (please explain below)

Checklist:

  • My code follows the Code Guidelines of this project
  • My change requires a change to the documentation, either Doxygen or wiki
  • I have updated the documentation accordingly
  • I have read the Contributing document
  • I have added tests to cover my change
  • All new and existing tests passed
@enen92

This comment has been minimized.

Copy link
Member Author

commented Mar 20, 2019

@romanvm can you review?

@romanvm
Copy link
Contributor

left a comment

Looks OK from technical point of view, but I'm really not familiar with Doxygen docstring formatting, so hopefully it looks OK in the compiled html version.

@enen92 enen92 merged commit 8f348eb into xbmc:master Mar 21, 2019

@Rechi Rechi added this to the Leia 18.2-rc1 milestone Mar 21, 2019

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
You can’t perform that action at this time.