[log4shib] 08/13: New patch Fix-Doxygen-formatting-issues.patch

[Ferenc Wágner]

This is an automated email from the git hooks/post-receive script.

wferi-guest pushed a commit to branch debian/master
in repository log4shib.

commit b20a1a1795d9dc952ee41a007598a4056763322e
Author: Ferenc Wágner <wferi at niif.hu>
Date:   Mon Apr 11 18:29:50 2016 +0200

    New patch Fix-Doxygen-formatting-issues.patch
    
    Fix Doxygen formatting issues
---
 debian/patches/Fix-Doxygen-formatting-issues.patch | 76 ++++++++++++++++++++++
 debian/patches/series                              |  1 +
 2 files changed, 77 insertions(+)

diff --git a/debian/patches/Fix-Doxygen-formatting-issues.patch b/debian/patches/Fix-Doxygen-formatting-issues.patch
new file mode 100644
index 0000000..a04802f
--- /dev/null
+++ b/debian/patches/Fix-Doxygen-formatting-issues.patch
@@ -0,0 +1,76 @@
+From: =?utf-8?q?Ferenc_W=C3=A1gner?= <wferi at niif.hu>
+Date: Mon, 11 Apr 2016 18:29:24 +0200
+Subject: Fix Doxygen formatting issues
+
+---
+ include/log4shib/PatternLayout.hh | 52 +++++++++++++++++++--------------------
+ 1 file changed, 25 insertions(+), 27 deletions(-)
+
+diff --git a/include/log4shib/PatternLayout.hh b/include/log4shib/PatternLayout.hh
+index a1bb956..4428edc 100644
+--- a/include/log4shib/PatternLayout.hh
++++ b/include/log4shib/PatternLayout.hh
+@@ -48,38 +48,36 @@ namespace log4shib {
+         PatternLayout();
+         virtual ~PatternLayout();
+         
+-        // NOTE: All double percentage signs ('%%') followed by a character
+-        //       in the following comments should actually be a single char.
+-        //       The doubles are included so that doxygen will print them correctly.
+         /**
+-         * Formats the LoggingEvent in the style set by
+-		 * the setConversionPattern call. By default, set
+-		 * to "%%m%%n"
++           Formats the LoggingEvent in the style set by
++           the setConversionPattern call. By default, set
++           to "%m%n"
+          **/
+         virtual std::string format(const LoggingEvent& event);
+ 
+         /**
+-         * Sets the format of log lines handled by this
+-         * PatternLayout. By default, set to "%%m%%n".<br>
+-         * Format characters are as follows:<br>
+-         * <li><b>%%</b> - a single percent sign</li>
+-         * <li><b>%%c</b> - the category</li>
+-         * <li><b>%%d</b> - the date\n
+-         *  Date format: The date format character may be followed by a date format 
+-         *  specifier enclosed between braces. For example, %%d{%%H:%%M:%%S,%%l} or %%d{%%d %%m %%Y %%H:%%M:%%S,%%l}.
+-         *  If no date format specifier is given then the following format is used:
+-         *  "Wed Jan 02 02:03:55 1980". The date format specifier admits the same syntax 
+-         *  as the ANSI C function strftime, with 1 addition. The addition is the specifier
+-         *  %%l for milliseconds, padded with zeros to make 3 digits.</li>
+-         * <li><b>%%m</b> - the message</li>
+-         * <li><b>%%n</b> - the platform specific line separator</li>
+-         * <li><b>%%p</b> - the priority</li>
+-         * <li><b>%%r</b> - milliseconds since this layout was created.</li>
+-         * <li><b>%%R</b> - seconds since Jan 1, 1970</li>
+-         * <li><b>%%u</b> - clock ticks since process start</li>
+-         * <li><b>%%x</b> - the NDC</li>
+-         * @param conversionPattern the conversion pattern
+-         * @exception ConfigureFailure if the pattern is invalid
++           Sets the format of log lines handled by this
++           PatternLayout. By default, set to "%m%n".
++           Format characters are as follows:
++           - <b>%%</b> - a single percent sign
++           - <b>%%c</b> - the category
++           - <b>%%d</b> - the date\n
++            Date format: The date format character may be followed by a date format
++            specifier enclosed between braces. For example, %%d{%%H:%%M:%%S,%%l} or %%d{%%d %%m %%Y %%H:%%M:%%S,%%l}.
++            If no date format specifier is given then the following format is used:
++            "Wed Jan 02 02:03:55 1980". The date format specifier admits the same syntax
++            as the ANSI C function strftime, with 1 addition. The addition is the specifier
++            %%l for milliseconds, padded with zeros to make 3 digits.
++           - <b>%%m</b> - the message
++           - <b>%%n</b> - the platform specific line separator
++           - <b>%%p</b> - the priority
++           - <b>%%r</b> - milliseconds since this layout was created
++           - <b>%%R</b> - seconds since Jan 1, 1970
++           - <b>%%u</b> - clock ticks since process start
++           - <b>%%x</b> - the NDC
++ 
++           @param conversionPattern the conversion pattern
++           @exception ConfigureFailure if the pattern is invalid
+          **/
+         virtual void setConversionPattern(const std::string& conversionPattern)
+             throw(ConfigureFailure);
diff --git a/debian/patches/series b/debian/patches/series
index 14d810c..19e2008 100644
--- a/debian/patches/series
+++ b/debian/patches/series
@@ -1,2 +1,3 @@
 Detach-upstream-debian-directory-from-the-build-syst.patch
 Don-t-leak-the-build-flags-into-the-pkg-config-file.patch
+Fix-Doxygen-formatting-issues.patch

-- 
Alioth's /usr/local/bin/git-commit-notice on /srv/git.debian.org/git/pkg-shibboleth/log4shib.git