Log4j 2
  1. Log4j 2
  2. LOG4J2-699

PatternLayout manual page missing documentation on header/footer

    Details

    • Type: Documentation Documentation
    • Status: Closed
    • Priority: Major Major
    • Resolution: Fixed
    • Affects Version/s: 2.0-rc2
    • Fix Version/s: 2.0
    • Component/s: Documentation
    • Labels:
      None

      Description

      PatternLayout manual page does not mention that this layout supports headers and footers.

      http://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout

      Documented parameters:

      • charset
      • pattern
      • replace
      • alwaysWriteExceptions

      Undocumented parameters:

      • config
      • noConsoleNoAnsi
      • header
      • footer

      I'm thinking to only document the header and footer parameters, but should the others be documented also?

        Activity

        Remko Popma created issue -
        Remko Popma made changes -
        Field Original Value New Value
        Description PatternLayout manual page does not mention that this layout supports headers and footers. PatternLayout manual page does not mention that this layout supports headers and footers.

        http://logging.apache.org/log4j/2.x/manual/layouts.html#PatternLayout

        Documented parameters:
        * charset
        * pattern
        * replace
        * alwaysWriteExceptions

        Undocumented parameters:
        * config
        * noConsoleNoAnsi
        * header
        * footer

        I'm thinking to only document the {{header}} and {{footer}} parameters, but should the others be documented also?
        Remko Popma made changes -
        Status Open [ 1 ] Resolved [ 5 ]
        Assignee Remko Popma [ remkop@yahoo.com ]
        Resolution Fixed [ 1 ]
        Matt Sicker made changes -
        Status Resolved [ 5 ] Closed [ 6 ]

          People

          • Assignee:
            Remko Popma
            Reporter:
            Remko Popma
          • Votes:
            0 Vote for this issue
            Watchers:
            4 Start watching this issue

            Dates

            • Created:
              Updated:
              Resolved:

              Development