docs(i18n): update style

gin-contrib · Jul 27, 2023 · 0c04a11 · 0c04a11
1 parent b8f7fd2
commit 0c04a11
Showing 1 changed file with 22 additions and 26 deletions.
diff --git a/i18n.go b/i18n.go
@@ -35,37 +35,33 @@ func Localize(opts ...Option) gin.HandlerFunc {
 	}
 }
 
-/*
-GetMessage get the i18n message
-
-	 param is one of these type: messageID, *i18n.LocalizeConfig
-	 Example:
-		GetMessage(context, "hello") // messageID is hello
-		GetMessage(context, &i18n.LocalizeConfig{
-				MessageID: "welcomeWithName",
-				TemplateData: map[string]string{
-					"name": context.Param("name"),
-				},
-		})
-*/
+// GetMessage get the i18n message with error handling
+// param is one of these type: messageID, *i18n.LocalizeConfig
+// Example:
+// GetMessage(context, "hello") // messageID is hello
+//
+//	GetMessage(context, &i18n.LocalizeConfig{
+//	  MessageID: "welcomeWithName",
+//	  TemplateData: map[string]string{
+//	    "name": context.Param("name"),
+//	  },
+//	})
 func GetMessage(context *gin.Context, param interface{}) (string, error) {
 	atI18n := context.Value("i18n").(GinI18n)
 	return atI18n.getMessage(context, param)
 }
 
-/*
-MustGetMessage get the i18n message without error handling
-
-	  param is one of these type: messageID, *i18n.LocalizeConfig
-	  Example:
-		MustGetMessage(context, "hello") // messageID is hello
-		MustGetMessage(context, &i18n.LocalizeConfig{
-				MessageID: "welcomeWithName",
-				TemplateData: map[string]string{
-					"name": context.Param("name"),
-				},
-		})
-*/
+// MustGetMessage get the i18n message without error handling
+// param is one of these type: messageID, *i18n.LocalizeConfig
+// Example:
+// MustGetMessage(context, "hello") // messageID is hello
+//
+//	MustGetMessage(context, &i18n.LocalizeConfig{
+//	  MessageID: "welcomeWithName",
+//	  TemplateData: map[string]string{
+//	    "name": context.Param("name"),
+//	  },
+//	})
 func MustGetMessage(context *gin.Context, param interface{}) string {
 	atI18n := context.MustGet("i18n").(GinI18n)
 	return atI18n.mustGetMessage(context, param)