diff --git a/doc/nbully.ndoc b/doc/nbully.ndoc deleted file mode 100644 index f4a04cd..0000000 --- a/doc/nbully.ndoc +++ /dev/null @@ -1,77 +0,0 @@ -%%outfile(%F) -%APPLICATION% -Version: %VSN% - -Authors: [Nomasystems, S.L. info@nomasystems.com] - -%%toc - -= MODULE = - -%%outfile(%F) - - -= DESCRIPTION = - -%APPLICATION% application module. - - -= START/STOP EXPORTS = - -Start/stop functions. - - -== start(Type, StartArgs) -> Result == - -: Types - : StartType = normal | {takeover, Node} | {failover, Node} - : Node = node() - : StartArgs = term() - : Result = {ok, Pid} | {ok, Pid, St} | {error, Reason} - : Pid = pid() - : St = term() - - -Starts the %APPLICATION% application. - - -== stop(State) -> ok == - -: Types - : State = term() - - -Stops the %APPLICATION% application. - - -= EXPORTS = - -Exported functions. - - -== leader() -> Leader == - -: Types - : Leader = atom() - - -Returns the node considered to be leader. - - -== subscribe() -> ok == - - -Subscribe to nbully worker process to receive leader updates. -``{nbully_leader_updated, NewLeader}`` messages will be received on leader updates. - - -== unsubscribe() -> ok == - - -Unsubscribes from nbully worker process to stop receiving leader updates - - - -= SEE ALSO = - -%APPLICATION%(1) diff --git a/doc/nbully_overview.ndoc b/doc/nbully_overview.ndoc deleted file mode 100644 index 0f50c0d..0000000 --- a/doc/nbully_overview.ndoc +++ /dev/null @@ -1,34 +0,0 @@ -%APPLICATION% Overview -Design -Version: %VSN% - -Authors: [Nomasystems, S.L. info@nomasystems.com] - -%%toc - -= MODULES = - -%MODULES% - - -= DESCRIPTION = - -nbully is the Nomasystems bully algorithm implementation for leader election. - - -= ARCHITECTURE = - -nbully application starts a supervisor that supervises a worker process. -This process runs in every node and consensuate node leadership with its -homologues in other nodes. - - -= ENVIRONMENT = - -The **%APPLICATION%** application requires some configuration parameters to -be present on startup. - - -= SEE ALSO = - -%MODULES%