Sorry, but the page you were trying to get to, does not exist. You +may want to try searching this site using the sidebar + or using our API Reference page +to find what you were looking for.
+ + +Welcome to docsh, a documentation engine for the Erlang shell. This project provides a number of helpers for accessing module and function doc comments, function specs and exported types.
EEP-0048 (http://erlang.org/eeps/eep-0048.html) docs_v1 documentation format support.
Documentation lookup functions exported in the Erlang shell.
'+(null!=(a=e.lambda(t,t))?a:"")+"
\n"},5:function(e,t,n,r,i){var a;return(null!=(a=s(o(18)).call(null!=t?t:e.nullContext||{},null!=t?t.results:t,{name:"isArray",hash:{},fn:e.program(6,i,0),inverse:e.program(8,i,0),data:i}))?a:"")+"\nThe search functionality is full-text based. Here are some tips:
\n\nfoo bar) are searched as OR* anywhere (such as fo*) as wildcard+ before a word (such as +foo) to make its presence required- before a word (such as -foo) to make its absence requiredWORD^NUMBER (such as foo^2) to boost the given wordWORD~NUMBER (such as foo~2) to do a search with edit distance on wordTo quickly go to a module, type, or function, use the autocompletion feature in the sidebar search.
\n"},6:function(e,t,n,r,i){return"Sorry, we couldn't find anything for "+e.escapeExpression(e.lambda(null!=t?t.value:t,t))+".
\n"},8:function(e,t,n,r,i){return"Invalid search: "+e.escapeExpression(e.lambda(null!=t?t.errorMessage:t,t))+".
\n"},compiler:[7,">= 4.0.0"],main:function(e,t,n,r,i){var a;return"Welcome to docsh, a documentation engine for the Erlang shell. This project provides a number of helpers for accessing module and function doc comments, function specs and exported types.
+ If you want your project to have embedded documentation, use rebar3_docsh plugin. If you want to browse some docs first, read on.
To access this documentation you've quite likely typed:
+ h(docsh). h/{1,2,3} is the most generic invocation of docsh. h/1 prints documentation for a given module (as shown above) or function:
h(fun lists:keyfind/3). h/{2,3} are limited to functions. h/2 displays information about all functions of the given name from a particular module, while h/3 also takes the expected function arity:
h(proplists, get_value).
+ h(proplists, get_value, 3). s/{1,2,3} is the helper to use if you're only interested in function specs, not their full documentation:
s(fun proplists:get_value/3).
+ s(proplists, get_value).
+ s(proplists, get_value, 3). t/{2,3} is the helper for printing types exported from modules:
t(gen_tcp, connect_option).
+ t(gen_udp, socket). If you want to use the helpers in erl you'll be set up by docsh's install script. It will install a user_default module enabling the shell extensions. See https://github.com/erszcz/docsh/README.md if unsure about the installation steps or what user_default is.
If you want to use docsh shell extensions in rebar3 shell, please refer to script/docsh_rebar3_shell.escript.
If you want to call docsh as a library, please refer to docsh_erl.
debug_info() :: + [erl_parse:abstract_form() | erl_parse:form_info()]. ++
t() ::
+ #docsh_beam{name :: module(),
+ beam_file :: file:filename(),
+ source_file :: file:filename() | false}.
+
+ abstract_code(t()) -> debug_info() | false. ++
source_file(t()) -> file:filename() | false. ++
EEP-0048 (http://erlang.org/eeps/eep-0048.html) docs_v1 documentation format support.
+Callback implementation for c::docsh_writer.from_internal/1.
Callback implementation for c::docsh_format.lookup/3.
Callback implementation for c::docsh_writer.from_internal/1.
Callback implementation for c::docsh_format.lookup/3.
Callback implementation for c::docsh_reader.available/1.
Callback implementation for c::docsh_reader.to_internal/1.
available(docsh_beam:t()) -> [docsh_reader:t()]. ++
Callback implementation for c::docsh_reader.available/1.
to_internal(docsh_beam:t()) -> R
+ when
+ R ::
+ {ok, docsh_internal:t()} |
+ {error, any(), [erlang:stack_item()]}.
+
+ Callback implementation for c::docsh_reader.to_internal/1.
#xmlElement.content as defined by xmerl.hrl.
xml_element_content() ::
+ [#xmlElement{} |
+ #xmlText{} |
+ #xmlPI{} |
+ #xmlComment{} |
+ #xmlDecl{}].
+
+ #xmlElement.content as defined by xmerl.hrl.
format_edoc(xml_element_content(), any()) -> iolist(). ++
Documentation lookup functions exported in the Erlang shell.
+When invoked with a module as an argument like h(lists), then look up the module documentation. When invoked with a fun as the argument like h(fun lists:keyfind/3), then equivalent to h(M, F, A) with the the fun's deduced {M :: module(), F :: name(), A :: arity()}.
Look up function documentation. Equivalent to h(M, F, any).
Look up function documentation. If arity is 'any', then all matching functions' docs will be printed. The complete info is function name/arity, spec and description. Use s/{1,2,3} to print just the spec.
Look up function spec. Equivalent to s(M, F, any).
Look up function spec. If arity is 'any' print specs for all matching functions.
Look up all types defined in module M.
Look up type definition. Equivalent to t(M, T, any).
Look up type definition. If arity is 'any' print definitions for all matching types.
When invoked with a module as an argument like h(lists), then look up the module documentation. When invoked with a fun as the argument like h(fun lists:keyfind/3), then equivalent to h(M, F, A) with the the fun's deduced {M :: module(), F :: name(), A :: arity()}.
Look up function documentation. Equivalent to h(M, F, any).
Look up function documentation. If arity is 'any', then all matching functions' docs will be printed. The complete info is function name/arity, spec and description. Use s/{1,2,3} to print just the spec.
Look up a function spec. Similar to h/1 used with a fun, but prints just the spec.
Look up function spec. Equivalent to s(M, F, any).
Look up function spec. If arity is 'any' print specs for all matching functions.
+Look up all types defined in module M.
Look up type definition. Equivalent to t(M, T, any).
Look up type definition. If arity is 'any' print definitions for all matching types.
+item_doc_not_available() -> error_message(). ++
lookup(t(), key(), kinds()) -> + {ok, [item()]} | {not_found, error_message()}. ++
module_doc_not_available() -> error_message(). ++
Show the difference between chunk sets of two modules.
Show the difference between chunk sets of two modules.
+compile_info_source_file(file:filename()) -> [file:filename()]. ++
get_abstract_code(file:filename()) -> + docsh_beam:debug_info() | false. ++
get_source_file(file:filename()) -> {ok, file:filename()} | false.
+
+ guessed_source_file(file:filename() | compiled_module()) -> + [file:filename()]. ++
make_docs(docsh_beam:t()) -> {ok, docsh_format:t(), [Warning]}
+ when Warning :: no_debug_info | no_src.
+
+ Callback implementation for c::docsh_reader.available/1.
Callback implementation for c::docsh_reader.to_internal/1.
available(docsh_beam:t()) -> [docsh_reader:t()]. ++
Callback implementation for c::docsh_reader.available/1.
to_internal(docsh_beam:t()) -> R
+ when
+ R ::
+ {ok, docsh_internal:t()} |
+ {error, any(), [erlang:stack_item()]}.
+
+ Callback implementation for c::docsh_reader.to_internal/1.
Start and monitor a tracer process.
+Default dbg:dhandler/2 is nice, but when you want to use domain knowledge or discard some of the data (like too long arg lists / retvals) it might be convenient to write your own dbg handler function. However, this is error prone and since you can't trace your trace function (d'oh!) hard to debug.
+The way to go is to setup a monitor on the trace handler process. When the trace function errors and kills the tracer process, you'll be notified. Still, if the monitor is setup by the shell, the 'DOWN' message might simply end up in the message queue of the shell and never be received - you won't know a crash happened.
+So, it's best to setup a process which will monitor the trace handler and print any 'DOWN' messages it receives.
+