Skip to content
This repository was archived by the owner on Apr 28, 2019. It is now read-only.

Pointer usage

Jump to bottom
Benjamin Arnold edited this page Jan 11, 2015 · 3 revisions

Documentation

When documenting methods that contain pointers, the following rules apply:

  • For a return type, the value must ALWAYS be decorated with CALLER_DELETE or CALLEE_DELETE, unless it is a getter function that just returns a member, in which case CALLEE_DELETE is assumed.
  • For an argument type, the decorators are assumed, by default, to be just CALLER_DELETE. Therefore, the only decorators you will ever add to arguments are OUT, OPT, and CALLEE_DELETE.

Clone this wiki locally