From d5e2d852ed1216be04d2497f9ac9afebbe017f2c Mon Sep 17 00:00:00 2001
From: 170210 <j170210@icloud.com>
Date: Tue, 8 Aug 2023 11:08:15 +0900
Subject: [PATCH] fixup: fix for comment

Signed-off-by: 170210 <j170210@icloud.com>
---
 .github/workflows/check-generated.yml         |  2 +-
 Makefile                                      |  4 ++--
 ..._error_docs.go => error_docs_generator.go} | 20 +++++++++++++++--
 .../error_doc/generator/errors_file_parser.go |  2 +-
 tools/error_doc/generator/keys_file_parser.go |  2 +-
 .../generator/module_directory_walker.go      | 22 -------------------
 6 files changed, 23 insertions(+), 29 deletions(-)
 rename tools/error_doc/generator/{generate_error_docs.go => error_docs_generator.go} (89%)
 delete mode 100644 tools/error_doc/generator/module_directory_walker.go

diff --git a/.github/workflows/check-generated.yml b/.github/workflows/check-generated.yml
index f613b5e993..1aa1b4f375 100644
--- a/.github/workflows/check-generated.yml
+++ b/.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 ">>"
diff --git a/Makefile b/Makefile
index 9e808cdc50..3acde110b2 100644
--- a/Makefile
+++ b/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                                  ###
diff --git a/tools/error_doc/generator/generate_error_docs.go b/tools/error_doc/generator/error_docs_generator.go
similarity index 89%
rename from tools/error_doc/generator/generate_error_docs.go
rename to tools/error_doc/generator/error_docs_generator.go
index 73e0fdb6a8..0f814ef3b1 100644
--- a/tools/error_doc/generator/generate_error_docs.go
+++ b/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
 			}
 		}
diff --git a/tools/error_doc/generator/errors_file_parser.go b/tools/error_doc/generator/errors_file_parser.go
index 502ad2558c..258eef75e1 100644
--- a/tools/error_doc/generator/errors_file_parser.go
+++ b/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)
diff --git a/tools/error_doc/generator/keys_file_parser.go b/tools/error_doc/generator/keys_file_parser.go
index 19fd739f8e..5a42c87500 100644
--- a/tools/error_doc/generator/keys_file_parser.go
+++ b/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
diff --git a/tools/error_doc/generator/module_directory_walker.go b/tools/error_doc/generator/module_directory_walker.go
deleted file mode 100644
index 429a333c9b..0000000000
--- a/tools/error_doc/generator/module_directory_walker.go
+++ /dev/null
@@ -1,22 +0,0 @@
-package generator
-
-import (
-	"os"
-	"path/filepath"
-)
-
-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
-}