Uploaded image for project: 'Moodle'
  1. Moodle
  2. MDL-72315

Fix/improve generated JSDoc for Report builder

    XMLWordPrintable

Details

    • Bug
    • Status: Closed
    • Minor
    • Resolution: Fixed
    • 4.0
    • 4.0
    • Report builder
    • MOODLE_400_STABLE
    • MOODLE_400_STABLE
    • Hide
      1. Generate jsdoc, e.g.:

        $ nvm use
        $ npm install
        $ ./node_modules/.bin/grunt jsdoc
        

      2. Confirm process completes without any warnings
      3. Browse generated jsdoc in your browser

      http://<YOURMOODLEURL>/jsdoc
      

      1. Confirm all core_reportbuilder/* modules contain documentation
      Show
      Generate jsdoc, e.g.: $ nvm use $ npm install $ ./node_modules/.bin/grunt jsdoc Confirm process completes without any warnings Browse generated jsdoc in your browser http://<YOURMOODLEURL>/jsdoc Confirm all core_reportbuilder/* modules contain documentation

    Description

      Seems when writing the JS modules for Report builder in MDL-70794, we missed the JSDoc implementation in MDL-71113

      Running it right now returns the following warnings (all relate to Report builder):

      ./node_modules/.bin/grunt jsdoc
      Running "jsdoc:dist" (jsdoc) task
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: filters.js, line: 16
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: report.js, line: 16
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: events.js, line: 16
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: events.js, line: 25
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: filters.js, line: 16
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: selectors.js, line: 16
      >> WARNING: The @package tag does not permit a value; the value will be ignored. File: selectors.js, line: 25
      >> Documentation generated
      

      Fix those warnings, and create useable documentation for Report builder JS modules

      Attachments

        Activity

          People

            pholden Paul Holden
            pholden Paul Holden
            Simey Lameze Simey Lameze
            Andrew Lyons Andrew Lyons
            Angelia Dela Cruz Angelia Dela Cruz
            David Matamoros, Mikel Martín Corrales, Paul Holden
            Votes:
            0 Vote for this issue
            Watchers:
            5 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved:
              19/Apr/22

              Time Tracking

                Estimated:
                Original Estimate - Not Specified
                Not Specified
                Remaining:
                Remaining Estimate - 0 minutes
                0m
                Logged:
                Time Spent - 1 hour, 11 minutes
                1h 11m