From db88502414c949f6194654ae0c8b4fe4990229eb Mon Sep 17 00:00:00 2001
From: Boming Zhang <bomingzh@sjtu.edu.cn>
Date: Fri, 21 Feb 2025 12:28:42 -0500
Subject: [PATCH] docs: add packages docs
---
cmd/joj3/conf/conf.go | 2 ++
cmd/joj3/env/env.go | 1 +
internal/parser/clangtidy/formatter.go | 2 +-
3 files changed, 4 insertions(+), 1 deletion(-)
diff --git a/cmd/joj3/conf/conf.go b/cmd/joj3/conf/conf.go
index 5c18a21..6242dd7 100644
--- a/cmd/joj3/conf/conf.go
+++ b/cmd/joj3/conf/conf.go
@@ -1,3 +1,5 @@
+// Package conf provides a configuration file parser for JOJ3.
+// The configuration file path is determined by the commit message.
package conf
import (
diff --git a/cmd/joj3/env/env.go b/cmd/joj3/env/env.go
index 8d9a01e..4535751 100644
--- a/cmd/joj3/env/env.go
+++ b/cmd/joj3/env/env.go
@@ -1,3 +1,4 @@
+// Package env stores the environment variables from actions environment.
package env
import (
diff --git a/internal/parser/clangtidy/formatter.go b/internal/parser/clangtidy/formatter.go
index 31d1b38..85ad3c2 100644
--- a/internal/parser/clangtidy/formatter.go
+++ b/internal/parser/clangtidy/formatter.go
@@ -1,4 +1,3 @@
-// Referenced from https://github.com/yuriisk/clang-tidy-converter/blob/master/clang_tidy_converter/parser/clang_tidy_parser.py
package clangtidy
import (
@@ -6,6 +5,7 @@ import (
"strings"
)
+// Referenced from https://github.com/yuriisk/clang-tidy-converter/blob/master/clang_tidy_converter/parser/clang_tidy_parser.py
type JsonMessage struct {
Type string `json:"type"`
CheckName string `json:"checkname"`