improved docs

This commit is contained in:
Lunny Xiao 2013-11-22 10:30:52 +08:00
parent e1644f7c98
commit 315bbec5e3
2 changed files with 3 additions and 56 deletions

View File

@ -92,56 +92,6 @@ func directCreateTable(engine *Engine, t *testing.T) {
}
}
func mapper(engine *Engine, t *testing.T) {
err := engine.UnMap(&Userinfo{})
if err != nil {
t.Error(err)
panic(err)
}
err = engine.Map(&Userinfo{}, &Userdetail{})
if err != nil {
t.Error(err)
panic(err)
}
err = engine.DropAll()
if err != nil {
t.Error(err)
panic(err)
}
err = engine.CreateAll()
if err != nil {
t.Error(err)
panic(err)
}
err = engine.CreateIndexes(&Userinfo{})
if err != nil {
t.Error(err)
panic(err)
}
err = engine.CreateIndexes(&Userdetail{})
if err != nil {
t.Error(err)
panic(err)
}
err = engine.CreateUniques(&Userinfo{})
if err != nil {
t.Error(err)
panic(err)
}
err = engine.CreateUniques(&Userdetail{})
if err != nil {
t.Error(err)
panic(err)
}
}
func insert(engine *Engine, t *testing.T) {
user := Userinfo{0, "xiaolunwen", "dev", "lunny", time.Now(),
Userdetail{Id: 1}, 1.78, []byte{1, 2, 3}, true}
@ -1656,8 +1606,6 @@ func testBool(engine *Engine, t *testing.T) {
func testAll(engine *Engine, t *testing.T) {
fmt.Println("-------------- directCreateTable --------------")
directCreateTable(engine, t)
fmt.Println("-------------- mapper --------------")
mapper(engine, t)
fmt.Println("-------------- insert --------------")
insert(engine, t)
fmt.Println("-------------- query --------------")

7
doc.go
View File

@ -3,12 +3,11 @@
// license that can be found in the LICENSE file.
/*
Package xorm is a simple and powerful ORM for Go. It makes
database operation simple.
Package xorm is a simple and powerful ORM for Go.
First, we should new a engine for a database
First, we should new an engine for a database
engine, err = xorm.NewEngine(driverName, dataSourceName)
engine, err := xorm.NewEngine(driverName, dataSourceName)
Method NewEngine's parameters is the same as sql.Open. It depends
drivers' implementation. Generally, one engine is enough.