aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
-rw-r--r--lib/diameter/doc/src/diameter.ent58
-rw-r--r--lib/diameter/doc/src/diameter.xml15
-rw-r--r--lib/diameter/doc/src/diameter_app.xml7
3 files changed, 30 insertions, 50 deletions
diff --git a/lib/diameter/doc/src/diameter.ent b/lib/diameter/doc/src/diameter.ent
index 81f1b01239..fbfbe817a9 100644
--- a/lib/diameter/doc/src/diameter.ent
+++ b/lib/diameter/doc/src/diameter.ent
@@ -23,23 +23,23 @@
<!-- diameter -->
<!ENTITY add_transport
- '<seealso marker="#add_transport">add_transport/2</seealso>'>
+ '<seealso marker="#add_transport-2">add_transport/2</seealso>'>
<!ENTITY call
- '<seealso marker="#call">call/4</seealso>'>
+ '<seealso marker="#call-4">call/4</seealso>'>
<!ENTITY origin_state_id
- '<seealso marker="#origin_state_id">origin_state_id/0</seealso>'>
+ '<seealso marker="#origin_state_id-0">origin_state_id/0</seealso>'>
<!ENTITY remove_transport
- '<seealso marker="#remove_transport">remove_transport/2</seealso>'>
+ '<seealso marker="#remove_transport-2">remove_transport/2</seealso>'>
<!ENTITY service_info
- '<seealso marker="#service_info">service_info/2</seealso>'>
+ '<seealso marker="#service_info-2">service_info/2</seealso>'>
<!ENTITY services
- '<seealso marker="#services">services/0</seealso>'>
+ '<seealso marker="#services-0">services/0</seealso>'>
<!ENTITY start_service
- '<seealso marker="#start_service">diameter:start_service/2</seealso>'>
+ '<seealso marker="#start_service-2">start_service/2</seealso>'>
<!ENTITY stop_service
- '<seealso marker="#stop_service">stop_service/1</seealso>'>
+ '<seealso marker="#stop_service-1">stop_service/1</seealso>'>
<!ENTITY subscribe
- '<seealso marker="#subscribe">subscribe/1</seealso>'>
+ '<seealso marker="#subscribe-1">subscribe/1</seealso>'>
<!ENTITY application_alias
'<seealso marker="#application_alias">application_alias()</seealso>'>
@@ -84,13 +84,13 @@
'<seealso marker="#watchdog_timer">watchdog_timer</seealso>'>
<!ENTITY mod_add_transport
- '<seealso marker="diameter#add_transport">diameter:add_transport/2</seealso>'>
+ '<seealso marker="diameter#add_transport-2">diameter:add_transport/2</seealso>'>
<!ENTITY mod_call
- '<seealso marker="diameter#call">diameter:call/4</seealso>'>
+ '<seealso marker="diameter#call-4">diameter:call/4</seealso>'>
<!ENTITY mod_remove_transport
- '<seealso marker="diameter#remove_transport">diameter:remove_transport/2</seealso>'>
+ '<seealso marker="diameter#remove_transport-2">diameter:remove_transport/2</seealso>'>
<!ENTITY mod_start_service
- '<seealso marker="diameter#start_service">diameter:start_service/2</seealso>'>
+ '<seealso marker="diameter#start_service-2">diameter:start_service/2</seealso>'>
<!ENTITY mod_call_opt
'<seealso marker="diameter#call_opt">diameter:call_opt()</seealso>'>
@@ -108,21 +108,21 @@
<!-- diameter_app -->
<!ENTITY handle_answer
- '<seealso marker="#handle_answer">handle_answer/4</seealso>'>
+ '<seealso marker="#Mod:handle_answer-4">handle_answer/4</seealso>'>
<!ENTITY handle_request
- '<seealso marker="#handle_request">handle_request/3</seealso>'>
+ '<seealso marker="#Mod:handle_request-3">handle_request/3</seealso>'>
<!ENTITY handle_error
- '<seealso marker="#handle_error">handle_error/4</seealso>'>
+ '<seealso marker="#Mod:handle_error-4">handle_error/4</seealso>'>
<!ENTITY peer_down
- '<seealso marker="#peer_down">peer_down/3</seealso>'>
+ '<seealso marker="#Mod:peer_down-3">peer_down/3</seealso>'>
<!ENTITY peer_up
- '<seealso marker="#peer_up">peer_up/3</seealso>'>
+ '<seealso marker="#Mod:peer_up-3">peer_up/3</seealso>'>
<!ENTITY pick_peer
- '<seealso marker="#pick_peer">pick_peer/4</seealso>'>
+ '<seealso marker="#Mod:pick_peer-4">pick_peer/4</seealso>'>
<!ENTITY prepare_retransmit
- '<seealso marker="#prepare_retransmit">prepare_retransmit/3</seealso>'>
+ '<seealso marker="#Mod:prepare_retransmit-3">prepare_retransmit/3</seealso>'>
<!ENTITY prepare_request
- '<seealso marker="#prepare_request">prepare_request/3</seealso>'>
+ '<seealso marker="#Mod:prepare_request-3">prepare_request/3</seealso>'>
<!ENTITY capabilities
'<seealso marker="#capabilities">capabilities()</seealso>'>
@@ -138,19 +138,19 @@
'<seealso marker="#state">state()</seealso>'>
<!ENTITY app_handle_answer
- '<seealso marker="diameter_app#handle_answer">handle_answer/4</seealso>'>
+ '<seealso marker="diameter_app#Mod:handle_answer-4">handle_answer/4</seealso>'>
<!ENTITY app_handle_request
- '<seealso marker="diameter_app#handle_request">handle_request/3</seealso>'>
+ '<seealso marker="diameter_app#Mod:handle_request-3">handle_request/3</seealso>'>
<!ENTITY app_handle_error
- '<seealso marker="diameter_app#handle_error">handle_error/4</seealso>'>
+ '<seealso marker="diameter_app#Mod:handle_error-4">handle_error/4</seealso>'>
<!ENTITY app_peer_up
- '<seealso marker="diameter_app#peer_up">peer_up/3</seealso>'>
+ '<seealso marker="diameter_app#Mod:peer_up-3">peer_up/3</seealso>'>
<!ENTITY app_pick_peer
- '<seealso marker="diameter_app#pick_peer">pick_peer/4</seealso>'>
+ '<seealso marker="diameter_app#Mod:pick_peer-4">pick_peer/4</seealso>'>
<!ENTITY app_prepare_retransmit
- '<seealso marker="diameter_app#prepare_retransmit">prepare_retransmit/3</seealso>'>
+ '<seealso marker="diameter_app#Mod:prepare_retransmit-3">prepare_retransmit/3</seealso>'>
<!ENTITY app_prepare_request
- '<seealso marker="diameter_app#prepare_request">prepare_request/3</seealso>'>
+ '<seealso marker="diameter_app#Mod:prepare_request-3">prepare_request/3</seealso>'>
<!ENTITY app_message
'<seealso marker="diameter_app#message">diameter_app:message()</seealso>'>
@@ -182,7 +182,7 @@
<!-- diameter_transport -->
<!ENTITY transport_start
- '<seealso marker="diameter_transport#start">start/3</seealso>'>
+ '<seealso marker="diameter_transport#Mod:start-3">start/3</seealso>'>
<!-- reference pages -->
diff --git a/lib/diameter/doc/src/diameter.xml b/lib/diameter/doc/src/diameter.xml
index 0392bd9bb7..2a2fff86a9 100644
--- a/lib/diameter/doc/src/diameter.xml
+++ b/lib/diameter/doc/src/diameter.xml
@@ -528,7 +528,7 @@ connectivity.</p>
<p>
Note that a single <c>up</c>/<c>down</c> event for a given peer
corresponds to one
-<seealso marker="diameter_app#peer_up">peer_up/peer_down</seealso>
+<seealso marker="diameter_app#Mod:peer_up-3">peer_up/peer_down</seealso>
callback for each of the Diameter applications negotiated during
capablilities exchange.
That is, the event communicates connectivity with the
@@ -1063,7 +1063,6 @@ identifies the configuration.</p>
</section>
-<marker id="add_transport"/>
<funcs>
<!-- ===================================================================== -->
@@ -1113,7 +1112,6 @@ been configured: a service can be started after configuring
its transports.</p>
</note>
-<marker id="call"/>
</desc>
</func>
@@ -1220,7 +1218,6 @@ Note that <c>{error,encode}</c> is the only return value which
guarantees that the request has <em>not</em> been sent over the
transport connection.</p>
-<marker id="origin_state_id"/>
</desc>
</func>
@@ -1239,7 +1236,6 @@ The value returned is the number of seconds since 19680120T031408Z,
the first value that can be encoded as a Diameter <c>&dict_Time;</c>,
at the time the diameter application was started.</p>
-<marker id="remove_transport"/>
</desc>
</func>
@@ -1287,7 +1283,6 @@ Whether or not a DPR message is sent to a peer is
controlled by value of &disconnect_cb;
configured on the transport.</p>
-<marker id="service_info"/>
</desc>
</func>
@@ -1590,7 +1585,6 @@ For example:</p>
</taglist>
-<marker id="services"/>
</desc>
</func>
@@ -1606,7 +1600,6 @@ For example:</p>
<p>
Return the list of started services.</p>
-<marker id="session_id"/>
</desc>
</func>
@@ -1627,7 +1620,6 @@ The value has the form required by section 8.8 of RFC 3588.
Ident should be the Origin-Host of the peer from which
the message containing the returned value will be sent.</p>
-<marker id="start"/>
</desc>
</func>
@@ -1644,7 +1636,6 @@ The diameter application must be started before starting a service.
In a production system this is typically accomplished by a boot
file, not by calling <c>start/0</c> explicitly.</p>
-<marker id="start_service"/>
</desc>
</func>
@@ -1675,7 +1666,6 @@ capabilities and restrict its supported Diameter applications so
necessarily the case.</p>
</note>
-<marker id="stop_service"/>
</desc>
</func>
@@ -1690,7 +1680,6 @@ Stop the diameter application.</p>
<p>
</p>
-<marker id="stop_service"/>
</desc>
</func>
@@ -1718,7 +1707,6 @@ Stopping a service does not remove any associated transports:
be called to remove transport configuration.</p>
</note>
-<marker id="subscribe"/>
</desc>
</func>
@@ -1741,7 +1729,6 @@ that does not yet exist.
Doing so before adding transports is required to guarantee the
reception of all related events.</p>
-<marker id="unsubscribe"/>
</desc>
</func>
diff --git a/lib/diameter/doc/src/diameter_app.xml b/lib/diameter/doc/src/diameter_app.xml
index c0aa2518af..826b28aaac 100644
--- a/lib/diameter/doc/src/diameter_app.xml
+++ b/lib/diameter/doc/src/diameter_app.xml
@@ -234,7 +234,6 @@ requests are received: &handle_request; callbacks must be
handled independently of &peer_up; and &peer_down;.</p>
</note>
-<marker id="peer_down"/>
</desc>
</func>
@@ -254,7 +253,6 @@ In particular, that the RFC 3539 watchdog state machine for the
connection has left state <c>OKAY</c> and the peer will no longer be a
candidate in &pick_peer; callbacks.</p>
-<marker id="pick_peer"/>
</desc>
</func>
@@ -324,7 +322,6 @@ value returned by a &peer_up;
or &peer_down; callback.</p>
</note>
-<marker id="prepare_request"/>
</desc>
</func>
@@ -378,7 +375,6 @@ callback has taken place to return <c>{error, Reason}</c>.
Returning <c>discard</c> is equivalent to returning <c>{discard,
discarded}</c>.</p>
-<marker id="prepare_retransmit"/>
</desc>
</func>
@@ -409,7 +405,6 @@ take place with <c>Reason</c> as initial argument.
Returning <c>discard</c> is equivalent to returning <c>{discard,
discarded}</c>.</p>
-<marker id="handle_answer"/>
</desc>
</func>
@@ -454,7 +449,6 @@ case.
The &mod_application_opt;
<c>answer_errors</c> can be set to change this behaviour.</p>
-<marker id="handle_error"/>
</desc>
</func>
@@ -483,7 +477,6 @@ that the transport connection to the peer to which the request has
been sent has become unavailable and that not alternate peer was
not selected.</p>
-<marker id="handle_request"/>
</desc>
</func>