Uploaded image for project: 'AeroGear'
  1. AeroGear
  2. AEROGEAR-2116

create API documentation for the iOS IDM SDK

    XMLWordPrintable

Details

    • Task
    • Resolution: Done
    • Major
    • None
    • None
    • None

    Description

      What

      This task is about write and generate the API docs for the swift SDK. For now the API docs should be generated within the repo.
      It should cover:

      • Review the API docs for the SDK and make sure they are complete and accurate
      • Generate the API doc. If there isn't any tooling available, work with the team to choose one.

      Attachments

        Issue Links

          is blocked by

          Task - Represents a small unit of work that is not end-user facing. AEROGEAR-2180 Create a script to generate the API docs for ios SDK

          • Major - To be worked after higher priority work items are addressed. When the severity is high and the effort to change it is low to moderate, this term is chosen. Issues in this category likely have an existing workaround but implementation or execution may be non-trivial.
          • Resolved

          Activity

            People

              roregan Rachael O'Regan (Inactive)
              lfitzger@redhat.com Laura Fitzgerald (Inactive)
              Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

                Created:
                Updated:
                Resolved:

                Time Tracking

                  Estimated:
                  Original Estimate - 1 day
                  1d
                  Remaining:
                  Remaining Estimate - 1 day
                  1d
                  Logged:
                  Time Spent - Not Specified
                  Not Specified