~samwhited/xmpp

23397645f3d4f5b73d337ba7a24672b63f09232e — Sam Whited 5 years ago 37dda70
Tweak JID documentation
4 files changed, 3 insertions(+), 35 deletions(-)

M jid/doc.go
M jid/safejid_test.go
M jid/unsafejid_test.go
M server/server.go
M jid/doc.go => jid/doc.go +1 -34
@@ 3,38 3,5 @@
// found in the LICENSE file.

// Package jid implements XMPP addresses (historically called "Jabber ID's" or
// "JID's") as described in RFC 7622.  The syntax for a JID is defined as
// follows using the Augmented Backus-Naur Form (ABNF):
//
//     jid          = [ localpart "@" ] domainpart [ "/" resourcepart ]
//     localpart    = 1*1023(userbyte)
//                    ;
//                    ; a "userbyte" is a byte used to represent a
//                    ; UTF-8 encoded Unicode code point that can be
//                    ; contained in a string that conforms to the
//                    ; UsernameCaseMapped profile of the PRECIS
//                    ; IdentifierClass defined in RFC 7613
//                    ;
//     domainpart   = IP-literal / IPv4address / ifqdn
//                    ;
//                    ; the "IPv4address" and "IP-literal" rules are
//                    ; defined in RFCs 3986 and 6874, respectively,
//                    ; and the first-match-wins (a.k.a. "greedy")
//                    ; algorithm described in Appendix B of RFC 3986
//                    ; applies to the matching process
//                    ;
//     ifqdn        = 1*1023(domainbyte)
//                    ;
//                    ; a "domainbyte" is a byte used to represent a
//                    ; UTF-8 encoded Unicode code point that can be
//                    ; contained in a string that conforms to RFC 5890
//                    ;
//     resourcepart = 1*1023(opaquebyte)
//                    ;
//                    ; an "opaquebyte" is a byte used to represent a
//                    ; UTF-8 encoded Unicode code point that can be
//                    ; contained in a string that conforms to the
//                    ; OpaqueString profile of the PRECIS
//                    ; FreeformClass defined in RFC 7613
//                    ;
// "JID's") as described in RFC 7622.
package jid

M jid/safejid_test.go => jid/safejid_test.go +1 -0
@@ 1,6 1,7 @@
// Copyright 2015 Sam Whited.
// Use of this source code is governed by the BSD 2-clause license that can be
// found in the LICENSE file.

package jid

import (

M jid/unsafejid_test.go => jid/unsafejid_test.go +1 -0
@@ 1,6 1,7 @@
// Copyright 2015 Sam Whited.
// Use of this source code is governed by the BSD 2-clause license that can be
// found in the LICENSE file.

package jid

import (

M server/server.go => server/server.go +0 -1
@@ 7,7 7,6 @@ import (
// A Server defines parameters for running an XMPP server.
type Server struct {
	options
	// handler ConnHandler // Connection handler to invoke.
}

// New creates a new XMPP server with the given options.