Uploaded image for project: 'eZ Publish / Platform'
  1. eZ Publish / Platform
  2. EZP-21271

As a developer, I want a complete and accurate API doc of the JS REST Client

    XMLWordPrintable

Details

    • Aconcagua Sprint 4, Aconcagua Sprint 6
    • 3

    Description

      The current API doc comment are inaccurate, miss examples. The documentation should be generated with yuidoc (without any error/warning).

      To ease the update and the fix of the documentation, the grunt script should be updated to have the following tasks:

      • doc: generate the documentation with yuidoc
      • livedoc: run yuidoc with the --server so that it's easy to do changes and check the result.

      Attachments

        Activity

          People

            Unassigned Unassigned
            damien.pobel-obsolete@ez.no Damien Pobel (Inactive)
            Votes:
            0 Vote for this issue
            Watchers:
            6 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:

              Time Tracking

                Estimated:
                Original Estimate - 3 days Original Estimate - 3 days
                3d
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 week, 2 days, 6 hours
                1w 2d 6h