From a6ef03a29dd30a6ab906d720567a6cacf7efe613 Mon Sep 17 00:00:00 2001 From: Michael Santos Date: Sun, 14 May 2023 08:51:39 -0400 Subject: [PATCH] doc: remove utility modules --- src/icmp6_message.erl | 1 + src/icmp_message.erl | 11 +++++++---- 2 files changed, 8 insertions(+), 4 deletions(-) diff --git a/src/icmp6_message.erl b/src/icmp6_message.erl index a0cbd1e..14eba5d 100644 --- a/src/icmp6_message.erl +++ b/src/icmp6_message.erl @@ -28,6 +28,7 @@ %%% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS %%% SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +%% @private -module(icmp6_message). -include_lib("pkt/include/pkt.hrl"). diff --git a/src/icmp_message.erl b/src/icmp_message.erl index 6be2ed0..c39da45 100644 --- a/src/icmp_message.erl +++ b/src/icmp_message.erl @@ -28,6 +28,7 @@ %%% NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS %%% SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. +%% @private -module(icmp_message). -include_lib("pkt/include/pkt.hrl"). @@ -39,15 +40,17 @@ code/1 ]). -%% @doc Convert an ICMP type to an integer. +%% Convert an ICMP type to an integer. +-spec type_to_uint8(atom() | integer()) -> gen_icmp:uint8_t(). type_to_uint8(Type) when is_integer(Type) -> Type; type_to_uint8(Type) when is_atom(Type) -> type(Type). -%% @doc Convert an ICMP code to an integer. +%% Convert an ICMP code to an integer. +-spec code_to_uint8(atom() | integer()) -> gen_icmp:uint8_t(). code_to_uint8(Code) when is_integer(Code) -> Code; code_to_uint8(Code) when is_atom(Code) -> code(Code). -%% @doc ICMP control message: types +%% ICMP control message: types type(?ICMP_ECHOREPLY) -> echoreply; type(?ICMP_DEST_UNREACH) -> dest_unreach; type(?ICMP_SOURCE_QUENCH) -> source_quench; @@ -75,7 +78,7 @@ type(info_reply) -> ?ICMP_INFO_REPLY; type(address) -> ?ICMP_ADDRESS; type(addressreply) -> ?ICMP_ADDRESSREPLY. -%% @doc ICMP control message: codes +%% ICMP control message: codes % destination unreachable code(unreach_net) -> ?ICMP_UNREACH_NET;