logging-log4net-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Berin Loritsch (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (LOG4NET-459) Generated API docs are unreadable
Date Fri, 20 Mar 2015 15:14:38 GMT

     [ 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)

Mime
View raw message