[jira] [Assigned] (TS-3694) Fix function documentation to Log::error

["Bryan Call (JIRA)" <ji...@apache.org>]

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

Bryan Call reassigned TS-3694:
------------------------------

    Assignee: Bryan Call

> Fix function documentation to Log::error
> ----------------------------------------
>
>                 Key: TS-3694
>                 URL: https://issues.apache.org/jira/browse/TS-3694
>             Project: Traffic Server
>          Issue Type: Improvement
>          Components: Logging
>            Reporter: Daniel Xu
>            Assignee: Bryan Call
>             Fix For: Docs
>
>
> The description for this function seems to be out of date. The note directly contradicts what the function actually does.
> {code:title=Log.cc|borderStyle=solid}
> /*-------------------------------------------------------------------------
>   Log::error
>   Make an entry into the current error log.  For convenience, it is given in
>   both variable argument (format, ...) and stdarg (format, va_list) forms.
>   Note that Log::error could call Log::va_error after calling va_start
>   so that va_error handles the statistics update. However, to make
>   Log::error slightly more efficient this is not the case. The
>   downside is that one has to be careful to update both functions if
>   need be.
>   -------------------------------------------------------------------------*/
> int
> Log::error(const char *format, ...)
> {
>   va_list ap;
>   int ret;
>   va_start(ap, format);
>   ret = Log::va_error(format, ap);
>   va_end(ap);
>   return ret;
> }
> {code}



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