fix for getting doc string for functions that return a type defined in the package: the doc is found under the type.. fixes missing gopy:interface=handle comment for such functions.

Author: Randall C. O'Reilly

bind/gen_func.go

@@ -220,7 +220,7 @@ func (g *pyGen) genMethod(s *symbol, o *Func) {
 }
 
 func isIfaceHandle(gdoc string) (bool, string) {
-	const PythonIface = "\ngopy:interface=handle"
+	const PythonIface = "gopy:interface=handle"
 	if idx := strings.Index(gdoc, PythonIface); idx >= 0 {
 		gdoc = gdoc[:idx] + gdoc[idx+len(PythonIface)+1:]
 		return true, gdoc

bind/package.go

@@ -132,6 +132,7 @@ func (p *Package) getDoc(parent string, o types.Object) string {
 		if err != nil {
 			return ""
 		}
+
 		doc := func() string {
 			if o.Parent() == nil || (o.Parent() != nil && parent != "") {
 				for _, typ := range p.doc.Types {
@@ -162,6 +163,28 @@ func (p *Package) getDoc(parent string, o types.Object) string {
 			return ""
 		}()
 
+		// if a function returns a type defined in the package,
+		// it is organized under that type
+		if doc == "" && sig.Results().Len() == 1 {
+			ret := sig.Results().At(0).Type()
+			if ntyp, ok := ret.(*types.Named); ok {
+				tn := ntyp.Obj().Name()
+				doc = func() string {
+					for _, typ := range p.doc.Types {
+						if typ.Name != tn {
+							continue
+						}
+						for _, m := range typ.Funcs {
+							if m.Name == n {
+								return m.Doc
+							}
+						}
+					}
+					return ""
+				}()
+			}
+		}
+
 		parseFn := func(tup *types.Tuple) []string {
 			params := []string{}
 			if tup == nil {