Permalink
Browse files

Update docs, bump version to 1.0.0

  • Loading branch information...
1 parent ca1e5e1 commit 7e45ff588fc293dbf7029a0b3f0254adeabaacee @Vagabond committed Dec 11, 2012
Showing with 10 additions and 10 deletions.
  1. +8 −8 README.md
  2. +2 −2 src/syslog.app.src
View
@@ -33,7 +33,7 @@ In erlang shell :
API
---
-### syslog:open(Ident, Logopt, Facility) ###
+### syslog:open(Ident, Logopt, Facility) -> {ok, port()} ###
_Ident_ is an arbitrary string
_Logopt_ is an atom or array of atom, you can use a number if you're brave enough :
@@ -72,10 +72,10 @@ _Facility_ is an atom :
* local7
The `open` call returns either `{ok, Log}` where _Log_ is a syslog handle
-that can be passed to subsequent `log` and `close` calls, or it returns
-`{error, Reason}`.
+that can be passed to subsequent `log` and `close` calls, or it will throw
+{error, badarg}.
-### syslog:log(Log, Priority, Message) ###
+### syslog:log(Log, Priority, Message) -> ok ###
_Log_ is a syslog handle returned from `open`
_Priority_ can be a number or better, an atom :
@@ -89,20 +89,20 @@ _Priority_ can be a number or better, an atom :
* info
* debug
-_Message_ is a string
+_Message_ is a string.
-### syslog:log(Log, Priority, FormatMsg, FormatArgs) ###
+### syslog:log(Log, Priority, FormatMsg, FormatArgs) -> ok ###
Same as above, but allows for the construction of log messages similar to
formatting strings via `io_lib:format/2`, where _FormatMsg_ indicates the
formatting instructions and _FormatArgs_ is a list of arguments to be
formatted.
-### syslog:close(Log) ###
+### syslog:close(Log) -> ok ###
_Log_ is a syslog handle returned from `open`
BUGS
----
- * Not a full OTP application
+ * None known
View
@@ -1,8 +1,8 @@
{application, syslog,
[
{description, "Syslog for erlang"},
- {vsn, "0.0.1"},
- {registered, []},
+ {vsn, "1.0.0"},
+ {registered, [syslog_sup, syslog]},
{applications, [
kernel,
stdlib

0 comments on commit 7e45ff5

Please sign in to comment.