Skip to content

Commit 2517a0b

Browse files
committed
Add doc comments for check functions
1 parent 918d845 commit 2517a0b

File tree

2 files changed

+5
-0
lines changed

2 files changed

+5
-0
lines changed

check/checkfunctions/library.go

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,15 @@ import (
88
"github.com/arduino/arduino-check/project/library/libraryproperties"
99
)
1010

11+
// LibraryPropertiesFormat checks for invalid library.properties format.
1112
func LibraryPropertiesFormat() (result checkresult.Type, output string) {
1213
if checkdata.LibraryPropertiesLoadError() != nil {
1314
return checkresult.Fail, checkdata.LibraryPropertiesLoadError().Error()
1415
}
1516
return checkresult.Pass, ""
1617
}
1718

19+
// LibraryPropertiesNameFieldMissing checks for missing library.properties "name" field.
1820
func LibraryPropertiesNameFieldMissing() (result checkresult.Type, output string) {
1921
if checkdata.LibraryPropertiesLoadError() != nil {
2022
return checkresult.NotRun, ""
@@ -26,6 +28,7 @@ func LibraryPropertiesNameFieldMissing() (result checkresult.Type, output string
2628
return checkresult.Pass, ""
2729
}
2830

31+
// LibraryPropertiesNameFieldDisallowedCharacters checks for disallowed characters in the library.properties "name" field.
2932
func LibraryPropertiesNameFieldDisallowedCharacters() (result checkresult.Type, output string) {
3033
if checkdata.LibraryPropertiesLoadError() != nil {
3134
return checkresult.NotRun, ""
@@ -38,6 +41,7 @@ func LibraryPropertiesNameFieldDisallowedCharacters() (result checkresult.Type,
3841
return checkresult.Pass, ""
3942
}
4043

44+
// LibraryPropertiesVersionFieldMissing checks for missing library.properties "version" field.
4145
func LibraryPropertiesVersionFieldMissing() (result checkresult.Type, output string) {
4246
if checkdata.LibraryPropertiesLoadError() != nil {
4347
return checkresult.NotRun, ""

check/checkfunctions/sketch.go

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,7 @@ import (
99
"github.com/arduino/arduino-check/check/checkresult"
1010
)
1111

12+
// PdeSketchExtension checks for use of deprecated .pde sketch file extensions.
1213
func PdeSketchExtension() (result checkresult.Type, output string) {
1314
directoryListing, _ := checkdata.ProjectPath().ReadDir()
1415
directoryListing.FilterOutDirs()

0 commit comments

Comments
 (0)