Need documentation on refcounting

Open
#3,448 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
4/5
Estimated time
3-5 days
Newbie friendliness
25/100
Issue type
Documentation
Clarity
Needs clarification
Activity status
Stale
Tech stack
cpp
Domain
documentation

Research direction

Start by locating the lower-level API refcounting implementation and any existing documentation that describes object lifetimes. Document how refcounting works for users of those APIs, including the relevant ownership rules. Done means the refcounting behavior is understandable without reading the implementation.

Written by the indexing model from the issue text.

Description

Effort: Low Impact: Low

What concept or API needs more documentation?

We need to provide better documentation on how we do refcounting. This is completely opaque to users of our lower-level APIs and should be explained better.

Dominant language
C++
Stars
1.3k
Forks
298
Avg merge
5d 5h
Merged PRs (30d)
19

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from Vector35/binaryninja-api

All issues in Vector35/binaryninja-api

Similar issues

More C++ issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.