1
0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00

vet: add suggestions for function documentation (#7890)

This commit is contained in:
Larpon
2021-01-10 17:48:39 +01:00
committed by GitHub
parent d96a1b8a5f
commit 93ad595ffb
10 changed files with 278 additions and 44 deletions

View File

@ -0,0 +1,49 @@
module foo
struct Foo {
foo int
}
pub fn foo() string {
// Missing doc
return 'foo'
}
// foo does bar
pub fn bar() string {
// not using convention style: '// <fn name>'
return 'bar'
}
// fooo does x
pub fn fooo() string {
// Documented
return 'fooo'
}
// booo does x
fn booo() string {
// Documented, but not pub
return 'booo'
}
fn boo() string {
// Missing doc
return 'boo'
}
pub fn (f Foo) foo() string {
// Missing doc
return f.fo()
}
fn (f Foo) fo() string {
// Missing doc, but not pub
return 'foo'
}
// wrong doc
pub fn (f Foo) fooo() string {
// not using convention
return f.fo()
}