Gdamore/dev2/iwyu

docs/LICENSE.adoc → docs/LICENSE.md

@@ -1,7 +1,7 @@
-= The MIT License
+# The MIT License
 
-Copyright 2018 Staysail Systems, Inc. <[email protected]> +
-Copyright 2018 Capitar IT Group BV <[email protected]>
+Copyright 2024 Staysail Systems, Inc. &lt;[[email protected]](mailto:[email protected])&gt; \
+Copyright 2018 Capitar IT Group BV &lt;[[email protected]](mailto:[email protected])&gt;
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"),

docs/man/CMakeLists.txt

@@ -104,8 +104,6 @@ if (NNG_ENABLE_DOC)
             nng_dialer_start
             nng_free
             nng_getopt
-            nng_inproc_register
-            nng_ipc_register
             nng_listen
             nng_listener_close
             nng_listener_create
@@ -188,15 +186,10 @@ if (NNG_ENABLE_DOC)
             nng_strfree
             nng_sub_open
             nng_surveyor_open
-            nng_tcp_register
-            nng_tls_register
             nng_url_clone
             nng_url_free
             nng_url_parse
             nng_version
-            nng_ws_register
-            nng_wss_register
-            nng_zt_register
             )
 
     set(NNG_MAN3HTTP

docs/man/libnng.3.adoc

@@ -204,20 +204,6 @@ The following functions are used to construct a socket with a specific protocol:
 |xref:nng_surveyor_open.3.adoc[nng_surveyor_open()]|open a surveyor socket
 |===
 
-=== Transports
-
-The following functions are used to register a transport for use.
-
-|===
-| xref:nng_inproc_register.3.adoc[nng_inproc_register()]|register inproc transport
-| xref:nng_ipc_register.3.adoc[nng_ipc_register()]|register IPC transport
-| xref:nng_tcp_register.3.adoc[nng_tcp_register()]|register TCP transport
-| xref:nng_tls_register.3.adoc[nng_tls_register()]|register TLS transport
-| xref:nng_ws_register.3.adoc[nng_ws_register()]|register WebSocket transport
-| xref:nng_wss_register.3.adoc[nng_wss_register()]|register WebSocket Secure transport
-| xref:nng_zt_register.3.adoc[nng_zt_register()]|register ZeroTier transport
-|===
-
 === Protocol Contexts
 
 The following functions are useful to separate the protocol processing
@@ -481,5 +467,4 @@ with TLS support.
 == SEE ALSO
 
 [.text-left]
-xref:nng_compat.3compat.adoc[nng_compat(3compat)],
 xref:nng.7.adoc[nng(7)]

docs/man/nng_inproc.7.adoc

@@ -1,6 +1,6 @@
 = nng_inproc(7)
 //
-// Copyright 2019 Staysail Systems, Inc. <[email protected]>
+// Copyright 2024 Staysail Systems, Inc. <[email protected]>
 // Copyright 2018 Capitar IT Group BV <[email protected]>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
 
 nng_inproc - intra-process transport
 
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/transport/inproc/inproc.h>
-
-int nng_inproc_register(void);
-----
-
 == DESCRIPTION
 
 (((transport, _inproc_)))
@@ -34,12 +25,8 @@ to slower transports when data must be moved within the same process.
 This transport tries hard to avoid copying data, and thus is very
 light-weight.
 
-=== Registration
-
-This transport is generally built-in to the core, so
-no extra steps to use it should be necessary.
-
 === URI Format
+
 (((URI, `inproc://`)))
 This transport uses URIs using the scheme `inproc://`, followed by
 an arbitrary string of text, terminated by a `NUL` byte.

docs/man/nng_ipc.7.adoc

@@ -1,6 +1,6 @@
 = nng_ipc(7)
 //
-// Copyright 2023 Staysail Systems, Inc. <[email protected]>
+// Copyright 2024 Staysail Systems, Inc. <[email protected]>
 // Copyright 2018 Capitar IT Group BV <[email protected]>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
 
 nng_ipc - IPC transport
 
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/transport/ipc/ipc.h>
-
-int nng_ipc_register(void);
-----
-
 == DESCRIPTION
 
 (((IPC)))(((transport, _ipc_)))
@@ -33,11 +24,6 @@ Other platforms may have different implementation strategies.
 
 // We need to insert a reference to the nanomsg RFC.
 
-=== Registration
-
-This transport is generally built-in to the core, so
-no extra steps to use it should be necessary.
-
 === URI Formats
 
 ==== Traditional Names

docs/man/nng_tcp.7.adoc

@@ -1,6 +1,6 @@
 = nng_tcp(7)
 //
-// Copyright 2019 Staysail Systems, Inc. <[email protected]>
+// Copyright 2024 Staysail Systems, Inc. <[email protected]>
 // Copyright 2018 Capitar IT Group BV <[email protected]>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
 
 nng_tcp - TCP/IP transport
 
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/transport/tcp/tcp.h>
-
-int nng_tcp_register(void);
-----
-
 == DESCRIPTION
 
 (((transport, _tcp_)))
@@ -31,11 +22,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.
 
 // We need to insert a reference to the nanomsg RFC.
 
-=== Registration
-
-This transport is generally built-in to the core of _NNG_, so
-no extra steps to use it should be necessary.
-
 === URI Format
 
 (((URI, `tcp://`)))

docs/man/nng_tls.7.adoc

@@ -1,6 +1,6 @@
 = nng_tls(7)
 //
-// Copyright 2019 Staysail Systems, Inc. <[email protected]>
+// Copyright 2024 Staysail Systems, Inc. <[email protected]>
 // Copyright 2018 Capitar IT Group BV <[email protected]>
 //
 // This document is supplied under the terms of the MIT License, a
@@ -13,15 +13,6 @@
 
 nng_tls - TLS transport
 
-== SYNOPSIS
-
-[source,c]
-----
-#include <nng/transport/tls/tls.h>
-
-int nng_tls_register(void);
-----
-
 == DESCRIPTION
 
 (((TLS)))(((Transport Layer Security)))(((transport, _tls_)))
@@ -34,12 +25,6 @@ Both IPv4 and IPv6 are supported when the underlying platform also supports it.
 The protocol details are documented in
 http://nanomsg.org/rfcs/sp-tls-v1.html[TLS Mapping for Scalability Protocols].
 
-=== Registration
-
-Depending upon how the library was built, it may be necessary to
-register the transport by calling
-xref:nng_tls_register.3.adoc[`nng_tls_register()`].
-
 === Availability
 
 The _tls_ transport depends on the use of an external library.