From 0f8436057f34be287793dd099a801e6a4baa0fd6 Mon Sep 17 00:00:00 2001 From: Ulf Wiger Date: Wed, 11 Jan 2012 09:55:06 +0100 Subject: [PATCH] docs rebuilt with new edown --- doc/gproc.md | 94 ++++++++++++++++++++++---------------------- doc/gproc_lib.md | 4 +- doc/gproc_monitor.md | 4 +- 3 files changed, 51 insertions(+), 51 deletions(-) diff --git a/doc/gproc.md b/doc/gproc.md index 6202c05..2aa7262 100644 --- a/doc/gproc.md +++ b/doc/gproc.md @@ -56,7 +56,7 @@ will improve performance. -
context() = {[scope()](#type-scope), [type()](#type-type)} | [type()](#type-type)
+
context() = {scope(), type()} | type()
{'all','all'} is the default @@ -67,7 +67,7 @@ will improve performance. -
headpat() = {[keypat()](#type-keypat), [pidpat()](#type-pidpat), ValPat}
+
headpat() = {keypat(), pidpat(), ValPat}
@@ -75,7 +75,7 @@ will improve performance. -
key() = {[type()](#type-type), [scope()](#type-scope), any()}
+
key() = {type(), scope(), any()}
@@ -83,7 +83,7 @@ will improve performance. -
keypat() = {[sel_type()](#type-sel_type) | [sel_var()](#type-sel_var), l | g | [sel_var()](#type-sel_var), any()}
+
keypat() = {sel_type() | sel_var(), l | g | sel_var(), any()}
@@ -91,7 +91,7 @@ will improve performance. -
pidpat() = pid() | [sel_var()](#type-sel_var)
+
pidpat() = pid() | sel_var()
@@ -99,7 +99,7 @@ will improve performance. -
reg_id() = {[type()](#type-type), [scope()](#type-scope), any()}
+
reg_id() = {type(), scope(), any()}
@@ -118,7 +118,7 @@ l = local registration; g = global registration -
sel_pattern() = [{[headpat()](#type-headpat), Guards, Prod}]
+
sel_pattern() = [{headpat(), Guards, Prod}]
@@ -134,7 +134,7 @@ l = local registration; g = global registration -
sel_type() = [type()](#type-type) | names | props | counters | aggr_counters
+
sel_type() = type() | names | props | counters | aggr_counters
@@ -161,7 +161,7 @@ a = aggregate_counter -
unique_id() = {n | a, [scope()](#type-scope), any()}
+
unique_id() = {n | a, scope(), any()}
##Function Index## @@ -303,7 +303,7 @@ Registers a local shared (unique) counter. -
await(Key::[key()](#type-key)) -> {pid(), Value}
+
await(Key::key()) -> {pid(), Value}


@@ -316,7 +316,7 @@ Equivalent to [`await(Key, infinity)`](#await-2). -
await(Key::[key()](#type-key), Timeout) -> {pid(), Value}
+
await(Key::key(), Timeout) -> {pid(), Value}
@@ -334,7 +334,7 @@ registered (the difference: await/2 also returns the value).key(), Ref) -> ok @@ -369,7 +369,7 @@ are canceled. -
demonitor(Key::[key()](#type-key), Ref::reference()) -> ok
+
demonitor(Key::key(), Ref::reference()) -> ok


@@ -384,7 +384,7 @@ set on a unique name. This function always succeeds given legal input.context()) -> key() | '$end_of_table'

@@ -402,7 +402,7 @@ The registry behaves as an ordered_set table. -
get_env(Scope::[scope()](#type-scope), App::atom(), Key::atom()) -> term()
+
get_env(Scope::scope(), App::atom(), Key::atom()) -> term()


@@ -415,8 +415,8 @@ Equivalent to [`get_env(Scope, App, Key, [app_env])`](#get_env-4).
  • Strategy = [Alternative]
  • Alternative = app_env | os_env | inherit | {inherit, pid()} | {inherit, <a href="#type-unique_id">unique_id()</a>} | init_arg | {mnesia, ActivityType, Oid, Pos} | {default, term()} | error
    • +
    get_env(Scope::scope(), App::atom(), Key::atom(), Strategy) -> term()
    + @@ -475,7 +475,7 @@ e.g. `get_env(l, mnesia, dir, [app_env, error])`. -
    get_set_env(Scope::[scope()](#type-scope), App::atom(), Key::atom()) -> term()
    +
    get_set_env(Scope::scope(), App::atom(), Key::atom()) -> term()


    @@ -488,7 +488,7 @@ Equivalent to [`get_set_env(Scope, App, Key, [app_env])`](#get_set_env-4).get_set_env(Scope::[scope()](#type-scope), App::atom(), Key::atom(), Strategy) -> Value +
    get_set_env(Scope::scope(), App::atom(), Key::atom(), Strategy) -> Value


    @@ -545,7 +545,7 @@ will be read. -
    give_away(From::[key()](#type-key), To::pid() | [key()](#type-key)) -> undefined | pid()
    +
    give_away(From::key(), To::pid() | key()) -> undefined | pid()


    @@ -650,7 +650,7 @@ same as [`http://www.erlang.org/doc/man/erlang.html#process_info-2`](http://www. -
    last(Context::[context()](#type-context)) -> [key()](#type-key) | '$end_of_table'
    +
    last(Context::context()) -> key() | '$end_of_table'


    @@ -808,7 +808,7 @@ Lookup the Pid stored with a key. -
    lookup_pids(Key::[key()](#type-key)) -> [pid()]
    +
    lookup_pids(Key::key()) -> [pid()]


    @@ -841,7 +841,7 @@ Lookup the value stored with a key. -
    lookup_values(Key::[key()](#type-key)) -> [{pid(), Value}]
    +
    lookup_values(Key::key()) -> [{pid(), Value}]


    @@ -860,7 +860,7 @@ object, the return value can be a list of any length. -
    monitor(Key::[key()](#type-key)) -> reference()
    +
    monitor(Key::key()) -> reference()


    @@ -881,7 +881,7 @@ If the name is not yet registered, the same message is sent immediately.mreg(T::[type()](#type-type), C::[scope()](#type-scope), KVL::[{Key::any(), Value::any()}]) -> true +
    mreg(T::type(), C::scope(), KVL::[{Key::any(), Value::any()}]) -> true


    @@ -900,7 +900,7 @@ or none are. -
    munreg(T::[type()](#type-type), C::[scope()](#type-scope), L::[Key::any()]) -> true
    +
    munreg(T::type(), C::scope(), L::[Key::any()]) -> true


    @@ -918,7 +918,7 @@ repeatedly. -
    nb_wait(Key::[key()](#type-key)) -> Ref
    +
    nb_wait(Key::key()) -> Ref


    @@ -933,7 +933,7 @@ The caller can expect to receive a message, -
    next(Context::[context()](#type-context), Key::[key()](#type-key)) -> [key()](#type-key) | '$end_of_table'
    +
    next(Context::context(), Key::key()) -> key() | '$end_of_table'


    @@ -951,7 +951,7 @@ The registry behaves as an ordered_set table. -
    prev(Context::[context()](#type-context), Key::[key()](#type-key)) -> [key()](#type-key) | '$end_of_table'
    +
    prev(Context::context(), Key::key()) -> key() | '$end_of_table'


    @@ -969,7 +969,7 @@ The registry behaves as an ordered_set table. -
    reg(Key::[key()](#type-key)) -> true
    +
    reg(Key::key()) -> true


    @@ -982,7 +982,7 @@ Equivalent to [`reg(Key, default(Key))`](#reg-2). -
    reg(Key::[key()](#type-key), Value) -> true
    +
    reg(Key::key(), Value) -> true


    @@ -999,7 +999,7 @@ Register a name or property for the current process -
    reg_shared(Key::[key()](#type-key)) -> true
    +
    reg_shared(Key::key()) -> true


    @@ -1017,7 +1017,7 @@ Register a resource, but don't tie it to a particular process. -
    reg_shared(Key::[key()](#type-key), Value) -> true
    +
    reg_shared(Key::key(), Value) -> true


    @@ -1044,7 +1044,7 @@ an aggregated counter which is owned by a process. -
    register_name(Name::[key()](#type-key), Pid::pid()) -> yes | no
    +
    register_name(Name::key(), Pid::pid()) -> yes | no


    @@ -1090,7 +1090,7 @@ see http://www.erlang.org/doc/man/ets.html#select-1 -
    select(Context::[context()](#type-context), Pat::[sel_pattern()](#type-sel_pattern)) -> [{Key, Pid, Value}]
    +
    select(Context::context(), Pat::sel_pattern()) -> [{Key, Pid, Value}]


    @@ -1108,7 +1108,7 @@ but the select patterns are transformed appropriately. -
    select(Context::[context()](#type-context), Pat::[sel_patten()](#type-sel_patten), Limit::integer()) -> {[Match], Continuation} | '$end_of_table'
    +
    select(Context::context(), Pat::sel_patten(), Limit::integer()) -> {[Match], Continuation} | '$end_of_table'


    @@ -1125,7 +1125,7 @@ See [`http://www.erlang.org/doc/man/ets.html#select-3`](http://www.erlang.org/do -
    select_count(Pat::[select_pattern()](#type-select_pattern)) -> [[sel_object()](#type-sel_object)]
    +
    select_count(Pat::select_pattern()) -> [sel_object()]


    @@ -1138,7 +1138,7 @@ Equivalent to [`select_count(all, Pat)`](#select_count-2).context(), Pat::sel_pattern()) -> [{Key, Pid, Value}]

    @@ -1156,7 +1156,7 @@ but the select patterns are transformed appropriately. -
    send(Key::[key()](#type-key), Msg::any()) -> Msg
    +
    send(Key::key(), Msg::any()) -> Msg


    @@ -1176,7 +1176,7 @@ property), Msg will be send to all processes that have such an object.scope(), App::atom(), Key::atom(), Value::term(), Strategy) -> Value @@ -1202,7 +1202,7 @@ to `undefined`. -
    set_value(Key::[key()](#type-key), Value) -> true
    +
    set_value(Key::key(), Value) -> true


    @@ -1256,7 +1256,7 @@ Equivalent to [`table({all, all})`](#table-1). -
    table(Context::[context()](#type-context)) -> any()
    +
    table(Context::context()) -> any()


    @@ -1269,7 +1269,7 @@ Equivalent to [`table(Context, [])`](#table-2). -
    table(Context::[context()](#type-context), Opts) -> any()
    +
    table(Context::context(), Opts) -> any()


    @@ -1284,7 +1284,7 @@ See [`http://www.erlang.org/doc/man/qlc.html`](http://www.erlang.org/doc/man/qlc -
    unreg(Key::[key()](#type-key)) -> true
    +
    unreg(Key::key()) -> true


    @@ -1297,7 +1297,7 @@ Unregister a name or property. -
    unreg_shared(Key::[key()](#type-key)) -> true
    +
    unreg_shared(Key::key()) -> true


    @@ -1321,7 +1321,7 @@ Equivalent to `unreg / 1`. -
    update_counter(Key::[key()](#type-key), Incr::integer()) -> integer()
    +
    update_counter(Key::key(), Incr::integer()) -> integer()


    @@ -1349,7 +1349,7 @@ will fail if the type of object referred to by Key is not a counter.key()) -> pid()

    diff --git a/doc/gproc_lib.md b/doc/gproc_lib.md index 877fc56..bc9b906 100644 --- a/doc/gproc_lib.md +++ b/doc/gproc_lib.md @@ -82,7 +82,7 @@ For a detailed description, see gproc/doc/erlang07-wiger.pdf.insert_many(T::[type()](#type-type), Scope::[scope()](#type-scope), KVL::[{[key()](#type-key), any()}], Pid::pid()) -> {true, list()} | false +
    insert_many(T::type(), Scope::scope(), KVL::[{key(), any()}], Pid::pid()) -> {true, list()} | false


    @@ -93,7 +93,7 @@ For a detailed description, see gproc/doc/erlang07-wiger.pdf.insert_reg(K::[key()](#type-key), Value::any(), Pid::pid() | shared, Scope::[scope()](#type-scope)) -> boolean() +
    insert_reg(K::key(), Value::any(), Pid::pid() | shared, Scope::scope()) -> boolean()


    diff --git a/doc/gproc_monitor.md b/doc/gproc_monitor.md index 7307ec0..8c84ab3 100644 --- a/doc/gproc_monitor.md +++ b/doc/gproc_monitor.md @@ -52,7 +52,7 @@ Starts the server -
    subscribe(Key::[key()](#type-key)) -> ok
    +
    subscribe(Key::key()) -> ok


    @@ -78,7 +78,7 @@ sent immediately, indicating the current status of the name.key()) -> ok