Uploaded image for project: 'Spring Framework'
  1. Spring Framework
  2. SPR-13642

Clarify javadoc for ContentNegotiationConfigurer's ignoreAcceptHeader

    Details

    • Type: Task
    • Status: Closed
    • Priority: Minor
    • Resolution: Complete
    • Affects Version/s: 4.2.2
    • Fix Version/s: 4.2.3
    • Component/s: [Documentation]
    • Labels:
      None
    • Last commented by a User:
      true

      Description

      Hello

      For the following classes:

      Both have practically the same introduction or explanation, where I can see for example:

      favorPathExtension PathExtensionContentNegotiationStrategy Yes

      If I do click in favorPathExtension for each class I can read for each method description that the default value is Yes.
      Same appreciation for favorParameter

      favorParameter ParameterContentNegotiationStrategy -

      Where here is false by default.

      Until here, the introduction and method description match well. They are the same.

      I have checked each row of the table (5 items)

      Here two observations:

      One:

      defaultContentTypeStrategy ContentNegotiationStrategy -

      If I do click in defaultContentTypeStrategy (for both classes) the setDefaultContentTypeStrategy does not indicate the default value.

      Two: (here the reason of this post)

      ignoreAcceptHeader HeaderContentNegotiationStrategy Yes

      Theoretically the method description (for both classes) should be yes by default, but really says

      By default this value is set to false.

      How you can see it says false. Not yes how is expected.

      I did not check the source code through GitHub, to see really what is the default value, but here there is no a match about the table against the method description. Here the error. So what is really the default value?.

      Thanks.

        Attachments

          Activity

            People

            • Assignee:
              rstoya05-aop Rossen Stoyanchev
              Reporter:
              dr_pompeii Manuel Jordan
              Last updater:
              St├ęphane Nicoll
            • Votes:
              0 Vote for this issue
              Watchers:
              2 Start watching this issue

              Dates

              • Created:
                Updated:
                Resolved:
                Days since last comment:
                2 years, 28 weeks, 4 days ago