diff options
author | Lukas Larsson <lukas@erlang.org> | 2020-02-18 16:30:48 +0100 |
---|---|---|
committer | Lukas Larsson <lukas@erlang.org> | 2020-02-24 09:52:59 +0100 |
commit | e58cf21c13b69b12211543d493d236f51103c0af (patch) | |
tree | 61b66b26473686eccafdbad9c6fb57970117fb7f | |
parent | eae33e2e3d4fc37fe0c6883b4aebf7acf5f93abc (diff) | |
download | erlang-e58cf21c13b69b12211543d493d236f51103c0af.tar.gz |
Fix docs to handle chunk generation
Many modules are only there as references for call-backs.
Also some functions seem to have documentation but no
implementation.
-rw-r--r-- | lib/et/doc/src/et_collector.xml | 24 | ||||
-rw-r--r-- | lib/et/src/et_collector.erl | 2 | ||||
-rw-r--r-- | lib/inets/src/http_server/httpd.erl | 3 | ||||
-rw-r--r-- | lib/megaco/doc/src/megaco.xml | 17 | ||||
-rw-r--r-- | lib/mnesia/doc/src/Mnesia_chap4.xmlsrc | 2 | ||||
-rw-r--r-- | lib/observer/doc/src/ttb.xml | 17 | ||||
-rw-r--r-- | lib/snmp/doc/src/snmp_pdus.xml | 1 | ||||
-rw-r--r-- | lib/tools/src/eprof.erl | 2 |
8 files changed, 19 insertions, 49 deletions
diff --git a/lib/et/doc/src/et_collector.xml b/lib/et/doc/src/et_collector.xml index f908612797..d258be2d40 100644 --- a/lib/et/doc/src/et_collector.xml +++ b/lib/et/doc/src/et_collector.xml @@ -139,19 +139,6 @@ </desc> </func> <func> - <name since="">load_event_file(CollectorPid, FileName) -> {ok, BadBytes} | exit(Reason)</name> - <fsummary>Load the event table from a file</fsummary> - <type> - <v>CollectorPid = pid()</v> - <v>FileName = string()</v> - <v>BadBytes = integer(X) where X >= 0</v> - <v>Reason = term()</v> - </type> - <desc> - <p>Load the event table from a file.</p> - </desc> - </func> - <func> <name since="">report(Handle, TraceOrEvent) -> {ok, Continuation} | exit(Reason)</name> <name since="">report_event(Handle, DetailLevel, FromTo, Label, Contents) -> {ok, Continuation} | exit(Reason)</name> <name since="">report_event(Handle, DetailLevel, From, To, Label, Contents) -> {ok, Continuation} | exit(Reason)</name> @@ -193,17 +180,6 @@ </desc> </func> <func> - <name since="">get_table_handle(CollectorPid) -> Handle</name> - <fsummary>Return a table handle</fsummary> - <type> - <v>CollectorPid = pid()</v> - <v>Handle = record(table_handle)</v> - </type> - <desc> - <p>Return a table handle.</p> - </desc> - </func> - <func> <name since="">get_global_pid() -> CollectorPid | exit(Reason)</name> <fsummary>Return a the identity of the globally registered collector if there is any</fsummary> <type> diff --git a/lib/et/src/et_collector.erl b/lib/et/src/et_collector.erl index 3609238509..7fa5dbda38 100644 --- a/lib/et/src/et_collector.erl +++ b/lib/et/src/et_collector.erl @@ -40,12 +40,10 @@ start_trace_client/3, start_trace_port/1, - %% load_event_file/2, save_event_file/3, clear_table/1, get_global_pid/0, - %% get_table_handle/1, get_table_size/1, change_pattern/2, make_key/2, diff --git a/lib/inets/src/http_server/httpd.erl b/lib/inets/src/http_server/httpd.erl index da785d8b43..ae35f109ed 100644 --- a/lib/inets/src/http_server/httpd.erl +++ b/lib/inets/src/http_server/httpd.erl @@ -41,7 +41,8 @@ reload_config/2, info/1, info/2, - info/3 + info/3, + info/4 ]). -deprecated({parse_query, 1, diff --git a/lib/megaco/doc/src/megaco.xml b/lib/megaco/doc/src/megaco.xml index c7bcdfcd6f..f5daa4dfce 100644 --- a/lib/megaco/doc/src/megaco.xml +++ b/lib/megaco/doc/src/megaco.xml @@ -1969,23 +1969,6 @@ megaco_incr_timer() = #megaco_incr_timer{} </func> <func> - <name since="">get_sdp_record_from_PropertGroup(Type, PG) -> [sdp()]</name> - <fsummary>Get all sdp records of a certain type from a property group</fsummary> - <type> - <v>Type = v | c | m | o | a | b | t | r | z | k | s | i | u | e | p</v> - <v>PG = sdp_property_group()</v> - <v>Reason = term()</v> - </type> - <desc> - <p>Retreive all the sdp records of type <c>Type</c> from the - property group <c>PG</c>.</p> - - <marker id="versions1"></marker> - <marker id="versions2"></marker> - </desc> - </func> - - <func> <name since="">versions1() -> {ok, VersionInfo} | {error, Reason}</name> <name since="">versions2() -> {ok, Info} | {error, Reason}</name> <fsummary>Retreive various system and application info</fsummary> diff --git a/lib/mnesia/doc/src/Mnesia_chap4.xmlsrc b/lib/mnesia/doc/src/Mnesia_chap4.xmlsrc index b8d86adbf1..b07c40b22f 100644 --- a/lib/mnesia/doc/src/Mnesia_chap4.xmlsrc +++ b/lib/mnesia/doc/src/Mnesia_chap4.xmlsrc @@ -761,7 +761,7 @@ mnesia:all_keys/1</seealso>. node but not the others. If the table resides locally, no waiting occurs.</p> <p>By passing the same "fun" as an argument to the function - <seealso marker="mnesia#sync_dirty/2">mnesia:sync_dirty(Fun [, Args])</seealso>, + <seealso marker="mnesia#sync_dirty/1">mnesia:sync_dirty(Fun [, Args])</seealso>, it is performed in almost the same context as the function <seealso marker="mnesia#async_dirty/2">mnesia:async_dirty/1,2</seealso>. The difference is that the operations are performed diff --git a/lib/observer/doc/src/ttb.xml b/lib/observer/doc/src/ttb.xml index fee95e0b21..ae5cc10b6e 100644 --- a/lib/observer/doc/src/ttb.xml +++ b/lib/observer/doc/src/ttb.xml @@ -277,8 +277,21 @@ ttb:p(all, call).</input></pre> </func> <func> - <name since="">tp, tpl, ctp, ctpl, ctpg</name> - <name since="OTP 19.0">tpe, ctpe</name> + <name since="">tp(Module [, Function [, Arity]], MatchSpec)</name> + <name since="">tp({Module, Function , Arity}, MatchSpec)</name> + <name since="">tpl(Module [, Function [, Arity]], MatchSpec)</name> + <name since="">tpl({Module, Function , Arity}, MatchSpec)</name> + <name since="">ctp()</name> + <name since="">ctp(Module [, Function [, Arity]])</name> + <name since="">ctp({Module, Function, Arity})</name> + <name since="">ctpl()</name> + <name since="">ctpl(Module [, Function [, Arity]])</name> + <name since="">ctpl({Module, Function, Arity})</name> + <name since="">ctpg()</name> + <name since="">ctpg(Module [, Function [, Arity]])</name> + <name since="">ctpg({Module, Function, Arity})</name> + <name since="OTP 19.0">tpe(Event,MatchSpec)</name> + <name since="OTP 19.0">ctpe(Event)</name> <fsummary>Set and clear trace patterns.</fsummary> <desc> <p>These functions are to be used with trace diff --git a/lib/snmp/doc/src/snmp_pdus.xml b/lib/snmp/doc/src/snmp_pdus.xml index 4b00dcb7f0..0377a1c050 100644 --- a/lib/snmp/doc/src/snmp_pdus.xml +++ b/lib/snmp/doc/src/snmp_pdus.xml @@ -125,7 +125,6 @@ <p>Decodes a list of bytes into an SNMP UsmSecurityParameters</p> </desc> </func> - <func> <name since="">enc_message(Message) -> [byte()]</name> <fsummary>Encode an SNMP Message</fsummary> diff --git a/lib/tools/src/eprof.erl b/lib/tools/src/eprof.erl index 86e3d3a8b8..ee72bad234 100644 --- a/lib/tools/src/eprof.erl +++ b/lib/tools/src/eprof.erl @@ -28,7 +28,7 @@ stop/0, dump/0, dump_data/0, start_profiling/1, start_profiling/2, start_profiling/3, - profile/1, profile/2, profile/3, profile/4, profile/5, + profile/1, profile/2, profile/3, profile/4, profile/5, profile/6, stop_profiling/0, analyze/0, analyze/1, analyze/2, analyze/4, log/1]). |