[TS-3694] Fix function documentation to Log::error

• Type: Improvement
• Status: Closed
• Priority: Trivial
• Resolution: Fixed
• Fix Version/s: Docs
• Component/s: Logging
• Assignee: Daniel Xu
• Reporter: Daniel Xu
• Created: 15/Jun/15 22:56
• Updated: 04/Feb/16 19:03
• Resolved: 18/Jun/15 15:48

Description

The description for this function seems to be out of date. The note directly contradicts what the function actually does.

Log.cc

/*-------------------------------------------------------------------------
  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;
}

Issue Links

• links to: Pull Request