Uploaded image for project: 'phpBB3'
  1. phpBB3
  2. PHPBB3-7941

mistake in description of function generate_board_url

    Details

    • Type: Bug
    • Status: Unverified Fix
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: None
    • Fix Version/s: 3.0.9-RC1
    • Component/s: Other
    • Labels:
      None

      Description

      Hi,

      on the following page:

      http://area51.phpbb.com/docs/code/phpBB3/_includes---functions.php.html#functiongenerate_board_url

      function generate_board_url is described this way:

      void generate_board_url ([bool $without_script_path = false])

      But when you look at

      function generate_board_url($without_script_path = false)

      in functions.php, you see return $url;

      $url is a string, so correct would be:

      string generate_board_url ([bool $without_script_path = false])

      Thank you
      Wolfgang

      Please move this bug report to the correct place, if it would be better located somewhere in the documentation section of the bug tracker.

        Activity

        Hide
        bantu Andreas Fischer added a comment -

        The documentation is being automatically generated from the code.

        Show
        bantu Andreas Fischer added a comment - The documentation is being automatically generated from the code.
        Hide
        IPB_Refugee Wolfgang Weber [X] (Inactive) added a comment -

        Hmm, that's bad, because in this case there's a bug in the script which automatically generates the documentation...

        Please take a look: void is wrong there.

        Have a nice evening!
        Wolfgang

        Show
        IPB_Refugee Wolfgang Weber [X] (Inactive) added a comment - Hmm, that's bad, because in this case there's a bug in the script which automatically generates the documentation... Please take a look: void is wrong there. Have a nice evening! Wolfgang
        Hide
        ToonArmy Chris Smith added a comment -

        The function comment is missing a @return tag I doubt we will fix this in 3.0 because its just more changes for no reason but 3.1 yes, so I will move it there.

        Show
        ToonArmy Chris Smith added a comment - The function comment is missing a @return tag I doubt we will fix this in 3.0 because its just more changes for no reason but 3.1 yes, so I will move it there.

          People

          • Assignee:
            Oleg Oleg [X] (Inactive)
            Reporter:
            IPB_Refugee Wolfgang Weber [X] (Inactive)
          • Votes:
            0 Vote for this issue
            Watchers:
            0 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development