Uploaded image for project: 'Fluid Infusion'
  1. Fluid Infusion
  2. FLUID-5461

Review framework API source code comments and compare to wiki pages

    XMLWordPrintable

    Details

    • Type: Task
    • Status: Closed
    • Priority: Blocker
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 1.5
    • Component/s: Tech. Documentation
    • Labels:
      None

      Description

      Review the source code comments for the framework API functions that we are linking to and compare to the existing wiki pages. Identify cases where there is significantly more information in the wiki pages than in the source code.

      In these cases, we should convert the wiki page to markdown, add to infusion-docs, and link to the converted page from the source code.

        Attachments

          Issue Links

          relates to

          Task - A task that needs to be done. FLUID-5329 Update the Framework API function source code comments

          • Blocker - Blocks development and/or testing work, production could not run.
          • Open

          Task - A task that needs to be done. FLUID-5791 Create markdown pages on the new documentation site to describe core Infusion APIs

          • Major - Major loss of function.
          • Closed

            Activity

              People

              Assignee:
              simon Simon Bates
              Reporter:
              simon Simon Bates
              Votes:
              0 Vote for this issue
              Watchers:
              1 Start watching this issue

                Dates

                Created:
                Updated:
                Resolved: