Skip to content

API reference documentation is missing all the async functions #498

@shepazon

Description

@shepazon

Description

The generated API reference for the Swift SDK is missing all the async functions; that is, the functions found in the foo+async.swift files.

Context

For example, open the documentation for IAM. First, the Async file isn't separately listed here, which is a good thing since you'd want it to all be together. But if you then go into the IamClient class and look for, say, getUser(), you find that it's only listed once, and only for the completion handler implementation.

Environment

  • AWS Swift SDK version used: 0.0.16
  • Operating System and version (iOS/macOS/Linux): macOS
  • Xcode version (if applicable): 13.2 beta 2

Reproduction Steps

See above.

Observed Behavior

See above.

Expected Behavior

Every function that has both completion handler and async versions available should be listed twice across the SDK reference; once for the completion handler version and once for the async version.

Possible Solution

See above.

Metadata

Metadata

Assignees

No one assigned

    Labels

    blockedWork is blocked on this issue for this codebase. Other labels or comments may indicate why.documentationThis is a problem with documentation.

    Type

    No type

    Projects

    No projects

    Milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions