File 2843-snmp-Types-and-specs-for-snmp-start_manage... of Package erlang

Overview Repositories Revisions Requests Users Attributes Meta

File 2843-snmp-Types-and-specs-for-snmp-start_manager-0-1.patch of Package erlang

From ba99d7d59d02d3473a1284db89ae2b7a1ca68a1d Mon Sep 17 00:00:00 2001
From: Micael Karlberg <bmk@erlang.org>
Date: Thu, 11 Jan 2024 08:39:45 +0100
Subject: [PATCH 23/67] [snmp] Types and specs for snmp:start_manager/0,1

---
 lib/snmp/doc/src/snmp.xml | 28 +++++++++++++---------------
 lib/snmp/src/app/snmp.erl |  8 ++++++++
 2 files changed, 21 insertions(+), 15 deletions(-)

diff --git a/lib/snmp/doc/src/snmp.xml b/lib/snmp/doc/src/snmp.xml
index 9790f85252..39f58270a5 100644
--- a/lib/snmp/doc/src/snmp.xml
+++ b/lib/snmp/doc/src/snmp.xml
@@ -238,24 +238,22 @@
 </func>
 
 <func>
- <name since="">start_manager() -> ok | {error, Reason}</name>
- <name since="">start_manager(Type) -> ok | {error, Reason}</name>
+ <name name="start_manager" arity="0" clause_i="1" since=""/>
+ <name name="start_manager" arity="1" clause_i="1" since=""/>
 <fsummary>Start the manager part of the SNMP application</fsummary>
- <type>
- <v>Type = start_type()</v>
- </type>
 <desc>
 The SNMP application consists of several entities, of which the
- manager is one. This function starts the manager entity of the 
- application. 
- 
- Note that the only way to actually start the manager in this way is
- to add the manager related config after starting the application (e.g
- it cannot be part of the normal application config; sys.config).
- This is done by calling: 
- <c>application:set_env(snmp, manager, Conf)</c>.
- 
- The default value for <c>Type</c> is <c>normal</c>.
+	manager is one. This function starts the manager entity of the 
+	application. 
+
+	Note that the only way to actually start the manager in this way is
+	to add the manager related config after starting the application (e.g
+	it cannot be part of the normal application config; sys.config).
+	This is done by calling: 
+	<c><![CDATA[application:set_env(snmp, manager, Conf)]]></c>. 
+
+	The default value for <c><![CDATA[Type]]></c> is
+	<c><![CDATA[normal]]></c>.
 
 <marker id="dat"></marker>
 <marker id="date_and_time"></marker>
diff --git a/lib/snmp/src/app/snmp.erl b/lib/snmp/src/app/snmp.erl
index 954e1bb784..525a7197b3 100644
--- a/lib/snmp/src/app/snmp.erl
+++ b/lib/snmp/src/app/snmp.erl
@@ -247,9 +247,17 @@ start_agent() ->
 start_agent(Type) ->
 snmp_app:start_agent(Type).
 
+
+-spec start_manager() -> ok | {error, Reason} when
+ Reason :: term().
+
 start_manager() ->
 snmp_app:start_manager().
 
+-spec start_manager(Type) -> ok | {error, Reason} when
+ Type :: application:start_type(),
+ Reason :: term().
+
 start_manager(Type) ->
 snmp_app:start_manager(Type).
 
-- 
2.35.3

Places

File 2843-snmp-Types-and-specs-for-snmp-start_manager-0-1.patch of Package erlang

Places