doc: add comments.

go-gorm · May 7, 2024 · 9932bbb · 9932bbb
1 parent 49b297c
commit 9932bbb
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 0 deletions.
diff --git a/helper/object.go b/helper/object.go
@@ -67,6 +67,7 @@ func CheckObject(obj Object) error {
 	return nil
 }
 
+// Method an object method interface
 type Method interface {
 	// Name return func name
 	Name() string
@@ -82,6 +83,7 @@ type Method interface {
 	Body() string
 }
 
+// Param an method param interface
 type Param interface {
 	// PackagePath return package path
 	PackagePath() string

diff --git a/internal/generate/export.go b/internal/generate/export.go
@@ -73,6 +73,7 @@ func getMethodParamFromParamObjs(objs []helper.Param) []parser.Param {
 	return list
 }
 
+// GetMethodFromObj convert helper.Method to parser.Method.
 func GetMethodFromObj(md helper.Method) *parser.Method {
 	return &parser.Method{
 		Receiver:   getMethodParamFromParamObj(md.Receiver()),
@@ -83,6 +84,8 @@ func GetMethodFromObj(md helper.Method) *parser.Method {
 		Body:       md.Body(),
 	}
 }
+
+// GetMethodSliceFromObj convert helper.Method slice to parser.Method slice.
 func GetMethodSliceFromObj(mds []helper.Method) []*parser.Method {
 	res := make([]*parser.Method, 0, len(mds))
 	for _, md := range mds {