diff options
author | Rob Pike <r@golang.org> | 2009-11-08 15:57:25 -0800 |
---|---|---|
committer | Rob Pike <r@golang.org> | 2009-11-08 15:57:25 -0800 |
commit | 40a7db3ee936509880754e79df791170d40827ea (patch) | |
tree | d6c46a7cf379adf41a719689646704931af8845f | |
parent | 56b45157409f2181499066ce9c9547999a82e233 (diff) | |
download | go-40a7db3ee936509880754e79df791170d40827ea.tar.gz go-40a7db3ee936509880754e79df791170d40827ea.zip |
add top-level package comments for net, reflect, malloc.
reflect is a little more detailed than some because it affords an opportunity
to explain how to approach the library.
R=gri, rsc
CC=go-dev
http://go/go-review/1026026
-rw-r--r-- | src/pkg/malloc/malloc.go | 3 | ||||
-rw-r--r-- | src/pkg/net/net.go | 3 | ||||
-rw-r--r-- | src/pkg/reflect/type.go | 11 |
3 files changed, 17 insertions, 0 deletions
diff --git a/src/pkg/malloc/malloc.go b/src/pkg/malloc/malloc.go index 838b92f5f2..66708a680e 100644 --- a/src/pkg/malloc/malloc.go +++ b/src/pkg/malloc/malloc.go @@ -6,6 +6,9 @@ // The actual functions are written in C // and part of the runtime library. +// The malloc package exposes statistics and other low-level details about +// the run-time memory allocator and collector. It is intended for debugging +// purposes only; other uses are discouraged. package malloc type Stats struct { diff --git a/src/pkg/net/net.go b/src/pkg/net/net.go index d649756ed5..cc5e27ea04 100644 --- a/src/pkg/net/net.go +++ b/src/pkg/net/net.go @@ -2,6 +2,9 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// The net package provides a portable interface to Unix +// networks sockets, including TCP/IP, UDP, domain name +// resolution, and Unix domain sockets. package net // TODO(rsc): diff --git a/src/pkg/reflect/type.go b/src/pkg/reflect/type.go index 02eb549e8d..e14892d580 100644 --- a/src/pkg/reflect/type.go +++ b/src/pkg/reflect/type.go @@ -2,6 +2,17 @@ // Use of this source code is governed by a BSD-style // license that can be found in the LICENSE file. +// The reflect package implements run-time reflection, allowing a program to +// manipulate objects with arbitrary types. The typical use is to take a +// value with static type interface{} and extract its dynamic type +// information by calling Typeof(), which returns an object with interface +// type Type. That contains a pointer to a struct of type *StructType, +// *IntType, etc. representing the details of the underlying type. A type +// switch or type assertion can reveal which. +// +// A call to NewValue creates a Value representing the run-time data; it +// contains a *StructValue, *IntValue, etc. MakeZero takes a Type and +// returns a Value representing a zero value for that type. package reflect import ( |