fixup: fix for comment

Signed-off-by: 170210 <j170210@icloud.com>

.github/workflows/check-generated.yml

@@ -26,7 +26,7 @@ jobs:
 
  - name: Check generated error docs
  run: |
- make error-doc
+ make error-doc-gen
  if ! git diff --stat --exit-code ; then
  echo ">> ERROR:"
  echo ">>"

Makefile

@@ -570,9 +570,9 @@ libsodium:
  fi
 .PHONY: libsodium
 
-error-doc:
+error-doc-gen:
  cd ./tools/error_doc && go run ./
-.PHONY: error-doc
+.PHONY: error-doc-gen
 
 ###############################################################################
 ### release ###

tools/error_doc/generator/generate_error_docs.go → tools/error_doc/generator/error_docs_generator.go

@@ -33,6 +33,22 @@ func NewErrorDocumentGenerator(p string) *ErrorDocumentGenerator {
  }
 }
 
+func (edg *ErrorDocumentGenerator) listUpErrorsGoFiles(startPath, errorsFileName string) error {
+ err := filepath.Walk(startPath, func(path string, info os.FileInfo, err error) error {
+ if err != nil {
+ return err
+ }
+ if !info.IsDir() && info.Name() == errorsFileName {
+ edg.errorsFiles = append(edg.errorsFiles, path)
+ }
+ return nil
+ })
+ if err != nil {
+ return err
+ }
+ return nil
+}
+
 func (edg *ErrorDocumentGenerator) extractModuleName() error {
  for _, filepath := range edg.errorsFiles {
  var moduleName string
@@ -75,10 +91,10 @@ func (edg *ErrorDocumentGenerator) generateContent() error {
  for _, moduleName := range edg.modules {
  mods := edg.errorDocument[moduleName]
  for _, mod := range mods {
- if err := mod.errorsFileParse(); err != nil {
+ if err := mod.parseErrorsFile(); err != nil {
  return err
  }
- if err := mod.keysFileParse(); err != nil {
+ if err := mod.parseKeysFile(); err != nil {
  return err
  }
  }

tools/error_doc/generator/errors_file_parser.go

@@ -61,7 +61,7 @@ func getConst(line string) (string, string, error) {
  return "", "", errors.New("failed to get the value in: " + line)
 }
 
-func (mi *moduleInfo) errorsFileParse() error {
+func (mi *moduleInfo) parseErrorsFile() error {
  // var errorDict []errorInfo
  // constDict := make(map[string]string)
  file, err := os.Open(mi.filepath)

tools/error_doc/generator/keys_file_parser.go

@@ -18,7 +18,7 @@ func getCodeSpace(line string) (string, string, error) {
  return "", "", errors.New("failed to get the value in: " + line)
 }
 
-func (mi *moduleInfo) keysFileParse() error {
+func (mi *moduleInfo) parseKeysFile() error {
  // find keys.go or key.go
  possibleFileNames := []string{"keys.go", "key.go"}
  var keyFilePath string