Return-Path: 
 <log4net-dev-return-5336-apmail-logging-log4net-dev-archive=logging.apache.org@logging.apache.org>
X-Original-To: apmail-logging-log4net-dev-archive@www.apache.org
Delivered-To: apmail-logging-log4net-dev-archive@www.apache.org
Received: from mail.apache.org (hermes.apache.org [140.211.11.3])
	by minotaur.apache.org (Postfix) with SMTP id 6896C17C3B
	for <apmail-logging-log4net-dev-archive@www.apache.org>;
 Fri, 20 Mar 2015 15:15:37 +0000 (UTC)
Received: (qmail 95432 invoked by uid 500); 20 Mar 2015 15:14:38 -0000
Delivered-To: apmail-logging-log4net-dev-archive@logging.apache.org
Received: (qmail 95259 invoked by uid 500); 20 Mar 2015 15:14:38 -0000
Mailing-List: contact log4net-dev-help@logging.apache.org; run by ezmlm
Precedence: bulk
list-help: <mailto:log4net-dev-help@logging.apache.org>
list-unsubscribe: <mailto:log4net-dev-unsubscribe@logging.apache.org>
List-Post: <mailto:log4net-dev@logging.apache.org>
Reply-To: "Log4NET Dev" <log4net-dev@logging.apache.org>
List-Id: <log4net-dev.logging.apache.org>
Delivered-To: mailing list log4net-dev@logging.apache.org
Received: (qmail 95094 invoked by uid 99); 20 Mar 2015 15:14:38 -0000
Received: from arcas.apache.org (HELO arcas.apache.org) (140.211.11.28)
    by apache.org (qpsmtpd/0.29) with ESMTP; Fri, 20 Mar 2015 15:14:38 +0000
Date: Fri, 20 Mar 2015 15:14:38 +0000 (UTC)
From: "Berin Loritsch (JIRA)" <jira@apache.org>
To: log4net-dev@logging.apache.org
Message-ID: <JIRA.12783640.1426864385000.157356.1426864478754@Atlassian.JIRA>
In-Reply-To: <JIRA.12783640.1426864385000@Atlassian.JIRA>
References: <JIRA.12783640.1426864385000@Atlassian.JIRA>
 <JIRA.12783640.1426864385112@arcas>
Subject: [jira] [Updated] (LOG4NET-459) Generated API docs are unreadable
MIME-Version: 1.0
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit
X-JIRA-FingerPrint: 30527f35849b9dde25b450d4833f0394


     [ https://issues.apache.org/jira/browse/LOG4NET-459?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Berin Loritsch updated LOG4NET-459:
-----------------------------------
    Description: 
Due to a character encoding problem, important characters like < and > and whatever character is used as a leader in the object hierarchy are completely mangled and hinders readability.

For an example see:

http://logging.apache.org/log4net/release/sdk/log4net.Appender.RollingFileAppender.html

Something in the build processing is messing things up, or the HTML is really UTF-8 but we are calling it "Windows 1252".  See the following line the header section of the HTML:

{code}
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
{code}

By manually changing that line to 

{code}
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
{code}

The readability improves, but is still not the correct character encoding.  Not sure what the encoding is supposed to be, or if the tool is introducing another layer of mangling.

The API docs really help, but having to sort through visual noise doesn't help.

  was:
Due to a character encoding problem, important characters like < and > and whatever character is used as a leader in the object hierarchy are completely mangled and hinders readability.

For an example see:

http://logging.apache.org/log4net/release/sdk/log4net.Appender.RollingFileAppender.html

Something in the build processing is messing things up, or the HTML is really UTF-8 but we are calling it "Windows 1521".  See the following line the header section of the HTML:

{code}
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
{code}

By manually changing that line to 

{code}
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
{code}

The readability improves, but is still not the correct character encoding.  Not sure what the encoding is supposed to be, or if the tool is introducing another layer of mangling.

The API docs really help, but having to sort through visual noise doesn't help.


> Generated API docs are unreadable
> ---------------------------------
>
>                 Key: LOG4NET-459
>                 URL: https://issues.apache.org/jira/browse/LOG4NET-459
>             Project: Log4net
>          Issue Type: Bug
>            Reporter: Berin Loritsch
>
> Due to a character encoding problem, important characters like < and > and whatever character is used as a leader in the object hierarchy are completely mangled and hinders readability.
> For an example see:
> http://logging.apache.org/log4net/release/sdk/log4net.Appender.RollingFileAppender.html
> Something in the build processing is messing things up, or the HTML is really UTF-8 but we are calling it "Windows 1252".  See the following line the header section of the HTML:
> {code}
> <meta http-equiv="Content-Type" content="text/html; charset=Windows-1252" />
> {code}
> By manually changing that line to 
> {code}
> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
> {code}
> The readability improves, but is still not the correct character encoding.  Not sure what the encoding is supposed to be, or if the tool is introducing another layer of mangling.
> The API docs really help, but having to sort through visual noise doesn't help.



--
This message was sent by Atlassian JIRA
(v6.3.4#6332)