docs: add docs file and add copyright

.github/workflows/pull-request.yml

@@ -56,7 +56,8 @@ jobs:
 
       - name: Generate all necessary files, such as error code files
         run: |
-          make generate
+          make gen.docgo.doc
+          make gen
           echo "Generate all necessary files successfully"
         continue-on-error: true
 

pkg/apistruct/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/authverify/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/callbackstruct/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/cachekey/doc.go

@@ -0,0 +1,15 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package cachekey // import "github.com/openimsdk/open-im-server/v3/pkg/common/cachekey"

pkg/common/cmd/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/config/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/convert/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/cache/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/controller/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/mgo/doc.go

@@ -0,0 +1,15 @@
+// Copyright © 2024 OpenIM. All rights reserved.
+//
+// Licensed under the Apache License, Version 2.0 (the "License");
+// you may not use this file except in compliance with the License.
+// You may obtain a copy of the License at
+//
+//     http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing, software
+// distributed under the License is distributed on an "AS IS" BASIS,
+// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+// See the License for the specific language governing permissions and
+// limitations under the License.
+
+package mgo // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/mgo"

pkg/common/db/s3/cont/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/s3/cos/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package cos // import "internal/pkg/pkg/common/db/s3/cos"
+package cos // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/cos"

pkg/common/db/s3/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/s3/minio/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package minio // import "internal/pkg/pkg/common/db/s3/minio"
+package minio // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/minio"

pkg/common/db/s3/oss/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package oss // import "internal/pkg/pkg/common/db/s3/oss"
+package oss // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/s3/oss"

pkg/common/db/table/relation/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package relation // import "internal/pkg/pkg/common/db/table/relation"
+package relation // import "github.com/openimsdk/open-im-server/v3/pkg/common/db/table/relation"

pkg/common/db/table/unrelation/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/db/unrelation/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/discoveryregister/direct/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package direct // import "internal/pkg/pkg/common/discoveryregister/direct"
+package direct // import "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister/direct"

pkg/common/discoveryregister/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package discoveryregister // import "internal/pkg/pkg/common/discoveryregister"
+package discoveryregister // import "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister"

pkg/common/discoveryregister/kubernetes/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package kubernetes // import "internal/pkg/pkg/common/discoveryregister/kubernetes"
+package kubernetes // import "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister/kubernetes"

pkg/common/discoveryregister/zookeeper/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package zookeeper // import "internal/pkg/pkg/common/discoveryregister/zookeeper"
+package zookeeper // import "github.com/openimsdk/open-im-server/v3/pkg/common/discoveryregister/zookeeper"

pkg/common/ginprometheus/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package ginprometheus // import "internal/pkg/pkg/common/ginprometheus"
+package ginprometheus // import "github.com/openimsdk/open-im-server/v3/pkg/common/ginprometheus"

pkg/common/http/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/kafka/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/common/prommetrics/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package prommetrics // import "internal/pkg/pkg/common/prommetrics"
+package prommetrics // import "github.com/openimsdk/open-im-server/v3/pkg/common/prommetrics"

pkg/common/redispubsub/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package redispubsub // import "internal/pkg/pkg/common/redispubsub"
+package redispubsub // import "github.com/openimsdk/open-im-server/v3/pkg/common/redispubsub"

pkg/common/startrpc/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.
@@ -12,5 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-// Package startrpc start rpc server.
+package startrpc // import "github.com/openimsdk/open-im-server/v3/pkg/common/startrpc"
-package startrpc

pkg/common/tls/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package tls // import "internal/pkg/pkg/common/tls"
+package tls // import "github.com/openimsdk/open-im-server/v3/pkg/common/tls"

pkg/common/version/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package version // import "internal/pkg/pkg/common/version"
+package version // import "github.com/openimsdk/open-im-server/v3/pkg/common/version"

pkg/localcache/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package localcache // import "internal/pkg/pkg/localcache"
+package localcache // import "github.com/openimsdk/open-im-server/v3/pkg/localcache"

pkg/localcache/link/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package link // import "internal/pkg/pkg/localcache/link"
+package link // import "github.com/openimsdk/open-im-server/v3/pkg/localcache/link"

pkg/localcache/lru/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package lru // import "internal/pkg/pkg/localcache/lru"
+package lru // import "github.com/openimsdk/open-im-server/v3/pkg/localcache/lru"

pkg/msgprocessor/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/rpccache/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package rpccache // import "internal/pkg/pkg/rpccache"
+package rpccache // import "github.com/openimsdk/open-im-server/v3/pkg/rpccache"

pkg/rpcclient/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/rpcclient/grouphash/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package grouphash // import "internal/pkg/pkg/rpcclient/grouphash"
+package grouphash // import "github.com/openimsdk/open-im-server/v3/pkg/rpcclient/grouphash"

pkg/rpcclient/notification/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/statistics/doc.go

@@ -1,4 +1,4 @@
-// Copyright © 2023 OpenIM. All rights reserved.
+// Copyright © 2024 OpenIM. All rights reserved.
 //
 // Licensed under the Apache License, Version 2.0 (the "License");
 // you may not use this file except in compliance with the License.

pkg/util/flag/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package flag // import "internal/pkg/pkg/util/flag"
+package flag // import "github.com/openimsdk/open-im-server/v3/pkg/util/flag"

pkg/util/genutil/doc.go

@@ -12,4 +12,4 @@
 // See the License for the specific language governing permissions and
 // limitations under the License.
 
-package genutil // import "internal/pkg/pkg/util/genutil"
+package genutil // import "github.com/openimsdk/open-im-server/v3/pkg/util/genutil"

scripts/gendoc.sh

@@ -13,52 +13,58 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-DEFAULT_DIRS=(
+#!/bin/bash
-  "pkg"
+
-  "internal/pkg"
+DEFAULT_DIRS=("pkg")
-)
 BASE_URL="github.com/openimsdk/open-im-server/v3"
+REMOVE_DOC=false
 
 usage() {
   echo "Usage: $0 [OPTIONS]"
   echo
-  echo "This script iterates over directories and generates doc.go if necessary."
+  echo "This script iterates over directories. By default, it generates doc.go files for 'pkg' and 'internal/pkg'."
-  echo "By default, it processes 'pkg' and 'internal/pkg' directories."
   echo
   echo "Options:"
-  echo "  -d DIRS, --dirs DIRS    Specify the directories to be processed, separated by commas. E.g., 'pkg,internal/pkg'."
+  echo "  -d DIRS, --dirs DIRS    Specify directories to process, separated by commas (e.g., 'pkg,internal/pkg')."
   echo "  -u URL, --url URL       Set the base URL for the import path. Default is '$BASE_URL'."
+  echo "  -r, --remove            Remove all doc.go files in the specified directories."
   echo "  -h, --help              Show this help message."
   echo
 }
 
 process_dir() {
-  local dir=$1
+  local dir="$1"
-  local base_url=$2
+  local base_url="$2"
+  local remove_doc="$3"
 
-  for d in $(find $dir -type d); do
+  find "$dir" -type d | while read -r d; do
-    if [ ! -f $d/doc.go ]; then
+    if [ "$remove_doc" = true ]; then
-      if ls $d/*.go > /dev/null 2>&1; then
+      if [ -f "$d/doc.go" ]; then
-        echo $d/doc.go
+        echo "Removing $d/doc.go"
-        echo "package $(basename $d) // import \"$base_url/$d\"" > $d/doc.go
+        rm -f "$d/doc.go"
+      fi
+    else
+      if [ ! -f "$d/doc.go" ] && ls "$d/"*.go &>/dev/null; then
+        echo "Creating $d/doc.go"
+        echo "package $(basename "$d") // import \"$base_url/$(echo "$d" | sed "s|^\./||")\"" >"$d/doc.go"
       fi
     fi
   done
 }
 
 while [[ $# -gt 0 ]]; do
-  key="$1"
+  case "$1" in
-  
-  case $key in
     -d|--dirs)
       IFS=',' read -ra DIRS <<< "$2"
-            shift # shift past argument
+      shift 2
-            shift # shift past value
       ;;
     -u|--url)
       BASE_URL="$2"
-            shift # shift past argument
+      shift 2
-            shift # shift past value
+      ;;
+    -r|--remove)
+      REMOVE_DOC=true
+      shift
       ;;
     -h|--help)
       usage
@@ -71,8 +77,8 @@ while [[ $# -gt 0 ]]; do
   esac
 done
 
-DIRS=${DIRS:-${DEFAULT_DIRS[@]}}
+DIRS=(${DIRS:-"${DEFAULT_DIRS[@]}"})
 
 for dir in "${DIRS[@]}"; do
-    process_dir $dir $BASE_URL
+  process_dir "$dir" "$BASE_URL" "$REMOVE_DOC"
 done