qbit/go
1
0
Fork 0
mirror of https://github.com/golang/go synced 2024-11-23 17:30:02 -07:00
Code Releases Activity

cmd/doc: add a line gap after a method with no comment

Browse Source 
Fixes #30492

Change-Id: Iec658bdf8bfac21e1bcc3eed900722cc535ec00a
Reviewed-on: https://go-review.googlesource.com/c/go/+/166178
Run-TryBot: Agniva De Sarker <agniva.quicksilver@gmail.com>
TryBot-Result: Gobot Gobot <gobot@golang.org>
Reviewed-by: Rob Pike <r@golang.org>
This commit is contained in:
Agniva De Sarker 2019-03-08 11:56:16 +05:30 committed by Agniva De Sarker
parent 6c6a0a1f2a
commit 055f16a9e9
3 changed files with 8 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
src/cmd/doc/doc_test.go
View File

@ -496,6 +496,7 @@ var tests = []test{
`func ReturnExported\(\) ExportedType`, `func ReturnExported\(\) ExportedType`,
`func \(ExportedType\) ExportedMethod\(a int\) bool`, `func \(ExportedType\) ExportedMethod\(a int\) bool`,
`Comment about exported method.`, `Comment about exported method.`,
`func \(ExportedType\) Uncommented\(a int\) bool\n\n`, // Ensure line gap after method with no comment
}, },
[]string{ []string{
`unexportedType`, `unexportedType`,

3
src/cmd/doc/pkg.go
View File

@ -808,6 +808,9 @@ func (pkg *Package) typeDoc(typ *doc.Type) {
for _, fun := range funcs { for _, fun := range funcs {
if isExported(fun.Name) { if isExported(fun.Name) {
pkg.emit(fun.Doc, fun.Decl) pkg.emit(fun.Doc, fun.Decl)
if fun.Doc == "" {
pkg.newlines(2)
}
} }
} }
} else { } else {

4
src/cmd/doc/testdata/pkg.go vendored
View File

@ -80,6 +80,10 @@ func (ExportedType) ExportedMethod(a int) bool {
return true != true return true != true
} }
func (ExportedType) Uncommented(a int) bool {
return true != true
}
// Comment about unexported method. // Comment about unexported method.
func (ExportedType) unexportedMethod(a int) bool { func (ExportedType) unexportedMethod(a int) bool {
return true return true