ParamPassDirection

public enum ParamPassDirection

Describes parameter passing direction for \param or \arg command. This determines how the callee of a function intends to use the argument. For example, an .in argument is meant to be consumed or read by the caller. An .out argument is usually a pointer and is meant to be filled by the caller, usually to return multiple pieces of data from a function. An .inout argument is meant to be read and written out to by the caller.

  • in

    The parameter is an input parameter.

    Declaration

    Swift

    case `in`
  • out

    The parameter is an output parameter.

    Declaration

    Swift

    case out
  • The parameter is an input and output parameter.

    Declaration

    Swift

    case `inout`