diff options
author | Steve Vinoski <vinoski@ieee.org> | 2013-03-29 13:30:09 -0400 |
---|---|---|
committer | Steve Vinoski <vinoski@ieee.org> | 2013-03-29 13:38:11 -0400 |
commit | 460cb28eda044c8dd8ce28ac6bc36bbc49373c8a (patch) | |
tree | 4a83c811d69a59efdc90e26d9d79b4697c6f41e8 /lib/stdlib/doc/src/sys.xml | |
parent | 9754ff636fac43cc550c443e18f90afacf21344e (diff) | |
download | otp-460cb28eda044c8dd8ce28ac6bc36bbc49373c8a.tar.gz otp-460cb28eda044c8dd8ce28ac6bc36bbc49373c8a.tar.bz2 otp-460cb28eda044c8dd8ce28ac6bc36bbc49373c8a.zip |
update sys:get_status/2,3 documentation for gen_event
Modify the documentation for the sys:get_status/2,3 functions to reflect
that they also work on gen_event processes, and add a cross reference for
gen_event:format_status/2 to go along with the existing cross references
for gen_server and gen_fsm.
Diffstat (limited to 'lib/stdlib/doc/src/sys.xml')
-rw-r--r-- | lib/stdlib/doc/src/sys.xml | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/lib/stdlib/doc/src/sys.xml b/lib/stdlib/doc/src/sys.xml index 073faf2df2..bb75efb5e7 100644 --- a/lib/stdlib/doc/src/sys.xml +++ b/lib/stdlib/doc/src/sys.xml @@ -211,14 +211,16 @@ <p>Gets the status of the process.</p> <p>The value of <c><anno>Misc</anno></c> varies for different types of processes. For example, a <c>gen_server</c> process returns - the callback module's state, and a <c>gen_fsm</c> process - returns information such as its current state name. Callback - modules for <c>gen_server</c> and <c>gen_fsm</c> can also - customise the value of <c><anno>Misc</anno></c> by exporting - a <c>format_status/2</c> function that contributes - module-specific information; - see <seealso marker="gen_server#Module:format_status/2">gen_server:format_status/2</seealso> - and <seealso marker="gen_fsm#Module:format_status/2">gen_fsm:format_status/2</seealso> + the callback module's state, a <c>gen_fsm</c> process + returns information such as its current state name and state data, + and a <c>gen_event</c> process returns information about each of its + registered handlers. Callback modules for <c>gen_server</c>, + <c>gen_fsm</c>, and <c>gen_event</c> can also customise the value + of <c><anno>Misc</anno></c> by exporting a <c>format_status/2</c> + function that contributes module-specific information; + see <seealso marker="gen_server#Module:format_status/2">gen_server:format_status/2</seealso>, + <seealso marker="gen_fsm#Module:format_status/2">gen_fsm:format_status/2</seealso>, and + <seealso marker="gen_event#Module:format_status/2">gen_event:format_status/2</seealso> for more details.</p> </desc> </func> |