ParamCommandComment

public struct ParamCommandComment: Comment

A \param or \arg command that describes the function parameter (name, passing direction, description). For example:

\param [in] ParamName description.

  • Undocumented

    Declaration

    Swift

    public let clang: CXComment

  • Retrieves the zero-based parameter index in the function prototype.

    Declaration

    Swift

    public var index: Int

  • The direction this parameter is passed by.

    Declaration

    Swift

    public var passDirection: ParamPassDirection

  • Retrieves the name of the declared parameter.

    Declaration

    Swift

    public var name: String

  • Determine if this parameter is actually a valid parameter in the declared function

    Declaration

    Swift

    public var isValidIndex: Bool

  • Determines if the parameter’s direction was explicitly stated in the function prototype.

    Declaration

    Swift

    public var isExplicitDirection: Bool