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

add to all templates comments documenting the parameters (variables) in use

    XMLWordPrintable

Details

    • Icon: Improvement Improvement
    • Resolution: Obsolete
    • Icon: Medium Medium
    • None
    • 2011.9, 4.6.0-dev
    • Documentation, Misc
    • None

    Description

      If is often hard for new developers to find out which variables to pass when including eg: the google paginator tempate, or the dadatype/view/ezimage template.

      It would be good to add a comment vlock at the top of every template, with a javadoc-style declaration of all variables that are used in the template without being declared there.
      Not only it would help new developers, but it could find its way in the online docs of modules and views.

      Of course this is a hard and long task, but a script could be developed that takes care of it in an automated way.

      Side note: this could be done after converting all let/default statements in templates to def/set ones

      Attachments

        Activity

          People

            Unassigned Unassigned
            72f8acac-185f-4a54-9470-a7473f50daab@accounts.ibexa.co Gaetano Giunta
            Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

              Created:
              Updated:
              Resolved: