Uploaded image for project: 'XWiki Platform'
  1. XWiki Platform
  2. XWIKI-8843

String action in class XWikiDocument method getURL should be documented or changed to enumeration

    Details

    • Type: Improvement
    • Status: Closed
    • Priority: Trivial
    • Resolution: Fixed
    • Affects Version/s: 4.5
    • Fix Version/s: 5.0-milestone-1
    • Component/s: URLs
    • Labels:
      None
    • Environment:
    • Difficulty:
      Trivial
    • Documentation:
      N/A
    • Documentation in Release Notes:
      N/A
    • Similar issues:

      Description

      The method getURL in class XWikiDocument needs a string parameter called action. It is not clear which values are valid here. We guessed view and it worked. Maybe "edit" is working as well, but guessing is not the right thing to do.
      Either use an enumeration instead of a string (preferred method) or provide a list of valid string values in the javadoc (quick fix).

        Attachments

          Activity

            People

            • Assignee:
              vmassol Vincent Massol
              Reporter:
              rpeinl René Peinl
            • Votes:
              0 Vote for this issue
              Watchers:
              3 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Date of First Response: