diff options
author | nagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-04-03 13:58:32 +0000 |
---|---|---|
committer | nagachika <nagachika@b2dd03c8-39d4-4d8f-98ff-823fe69b080e> | 2011-04-03 13:58:32 +0000 |
commit | 6a06e94046401e861ecb3f88b10b22d2c85aac14 (patch) | |
tree | 81fc825289a3432637afbb9de94b5d4bcb2a6b3a /ext/syslog | |
parent | 11b1f4ff92f4eb5ab5be8d7b9c4ee7b1f6111148 (diff) | |
download | ruby-6a06e94046401e861ecb3f88b10b22d2c85aac14.tar.gz |
* ext/syslog/syslog.c: improve rdoc.
a patch by Jonas Pfenniger. [ruby-core:35592] fixes #4545
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@31234 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/syslog')
-rw-r--r-- | ext/syslog/syslog.c | 20 |
1 files changed, 14 insertions, 6 deletions
diff --git a/ext/syslog/syslog.c b/ext/syslog/syslog.c index e72eb930ff..f7d622ef34 100644 --- a/ext/syslog/syslog.c +++ b/ext/syslog/syslog.c @@ -178,7 +178,7 @@ static VALUE mSyslog_open(int argc, VALUE *argv, VALUE self) } /* call-seq: - * open(ident, options, facility) => syslog + * reopen(ident, options, facility) => syslog * * :yields: syslog * @@ -193,7 +193,9 @@ static VALUE mSyslog_reopen(int argc, VALUE *argv, VALUE self) return mSyslog_open(argc, argv, self); } -/* +/* call-seq: + * opened? + * * Returns true if the syslog is open. */ static VALUE mSyslog_isopen(VALUE self) @@ -231,7 +233,7 @@ static VALUE mSyslog_get_mask(VALUE self) } /* call-seq: - * mask(priority_mask) + * mask=(priority_mask) * * Sets the log priority mask. A method LOG_UPTO is defined to make it easier * to set mask values. Example: @@ -258,12 +260,12 @@ static VALUE mSyslog_set_mask(VALUE self, VALUE mask) } /* call-seq: - * log(priority, format-string, ... ) + * log(priority, format_string, *format_args) * * Log a message with the specified priority. Example: * - * log(Syslog::LOG_CRIT, "Out of disk space") - * log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) + * Syslog.log(Syslog::LOG_CRIT, "Out of disk space") + * Syslog.log(Syslog::LOG_CRIT, "User %s logged in", ENV['USER']) * * The priority levels, in descending order, are: * @@ -276,6 +278,12 @@ static VALUE mSyslog_set_mask(VALUE self, VALUE mask) * LOG_INFO:: Informational message * LOG_DEBUG:: Debugging information * + * Each priority level also has a shortcut method that logs with it's named priority. + * As an example, the two following statements would produce the same result: + * + * Syslog.log(Syslog::LOG_ALERT, "Out of memory") + * Syslog.alert("Out of memory") + * * Format strings are as for printf/sprintf, except that in addition %m is * replaced with the error message string that would be returned by * strerror(errno). |