Skip to content
Snippets Groups Projects
Commit bdfc3b69 authored by Jono Wenger's avatar Jono Wenger
Browse files

Fix more doc links

parent dd468c63
No related branches found
No related tags found
1 merge request!60Revert "Fail a test to be sure it works"
......@@ -11,6 +11,7 @@ package wasm
import (
"github.com/spf13/jwalterweatherman"
"gitlab.com/elixxir/client/auth"
"gitlab.com/elixxir/client/catalog"
"gitlab.com/elixxir/client/channels"
"gitlab.com/elixxir/client/cmix"
......@@ -60,4 +61,5 @@ var (
_ = jwalterweatherman.LogListener(nil)
_ = format.Message{}
_ = restlike.Message{}
_ = auth.Callbacks(nil)
)
......@@ -90,10 +90,10 @@ func (dt *DummyTraffic) SetStatus(_ js.Value, args []js.Value) interface{} {
// GetStatus returns the current state of the [DummyTraffic] manager's sending
// thread. Note that this function does not return the status set by the most
// recent call to [SetStatus]. Instead, this call returns the current status of
// the sending thread. This is due to the small delay that may occur between
// calling [SetStatus] and the sending thread taking into effect that status
// change.
// recent call to [DummyTraffic.SetStatus]. Instead, this call returns the
// current status of the sending thread. This is due to the small delay that may
// occur between calling [DummyTraffic.SetStatus] and the sending thread taking
// into effect that status change.
//
// Returns:
// - Returns true if sending thread is sending dummy messages and false if
......
......@@ -18,8 +18,8 @@ import (
// structure to the passed contact, as well as the passed facts (it will error
// if they are too long).
//
// The other party must accept the request by calling [Confirm] to be able to
// send messages using [E2e.SendE2E]. When the other party does so, the
// The other party must accept the request by calling [E2e.Confirm] to be able
// to send messages using [E2e.SendE2E]. When the other party does so, the
// "confirm" callback will get called.
//
// The round the request is initially sent on will be returned, but the request
......@@ -69,7 +69,7 @@ func (e *E2e) Request(_ js.Value, args []js.Value) interface{} {
// The confirmation sends as a critical message; if the round it sends on fails,
// it will be auto resent by the cMix client.
//
// If the confirmation must be resent, use [ReplayConfirm].
// If the confirmation must be resent, use [E2e.ReplayConfirm].
//
// Parameters:
// - args[0] - Marshalled bytes of the partner [contact.Contact] (Uint8Array).
......
......@@ -135,9 +135,9 @@ func (c *Cmix) GetNodeRegistrationStatus(js.Value, []js.Value) interface{} {
// HasRunningProcessies checks if any background threads are running and returns
// true if one or more are.
//
// This is meant to be used when [NetworkFollowerStatus] returns Stopping. Due
// to the handling of comms on iOS, where the OS can block indefinitely, it may
// not enter the stopped state appropriately. This can be used instead.
// This is meant to be used when [Cmix.NetworkFollowerStatus] returns Stopping.
// Due to the handling of comms on iOS, where the OS can block indefinitely, it
// may not enter the stopped state appropriately. This can be used instead.
//
// Returns:
// - True if there are running processes (boolean).
......
......@@ -198,9 +198,10 @@ func (ud *UserDiscovery) GetContact(js.Value, []js.Value) interface{} {
return utils.CopyBytesToJS(c)
}
// ConfirmFact confirms a fact first registered via [SendRegisterFact]. The
// confirmation ID comes from [SendRegisterFact] while the code will come over
// the associated communications system.
// ConfirmFact confirms a fact first registered via
// [UserDiscovery.SendRegisterFact]. The confirmation ID comes from
// [UserDiscovery.SendRegisterFact] while the code will come over the associated
// communications system.
//
// Parameters:
// - args[0] - Confirmation ID (string).
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment