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

Improve event php doc to include other information

XMLWordPrintable

    • Icon: Bug Bug
    • Resolution: Fixed
    • Icon: Blocker Blocker
    • 2.7
    • 2.6
    • Events API
    • 13
    • BACKEND Sprint 8

      Event php doc should be improved to include other information if exists.
      Base contains information about the event, but other params are specific to event and should be documented, so it can be read by systemx for documentation.

      I have been looking at this and there is a proposal in PHP-Fig (psr-5) https://github.com/php-fig/fig-standards/pull/169/files#diff-9a10a11696dc38209c125ea9c57a565fR1245

      Wordpress also suggest similar documentation http://make.wordpress.org/core/handbook/inline-documentation-standards/php-documentation-standards/#1-1-parameters-that-are-arrays

            rajeshtaneja Rajesh Taneja
            rajeshtaneja Rajesh Taneja
            Petr Skoda Petr Skoda
            Sam Hemelryk Sam Hemelryk
            Sam Hemelryk Sam Hemelryk
            Votes:
            0 Vote for this issue
            Watchers:
            7 Start watching this issue

              Created:
              Updated:
              Resolved:

                Error rendering 'clockify-timesheets-time-tracking-reports:timer-sidebar'. Please contact your Jira administrators.