update document

README.md

@@ -11,7 +11,7 @@
 
 ## Introduction
 
-PublicCMS is an open source JAVACMS system developed with mainstream technologies in 2023. Developed by Tianjin Black Core Technology Co., LTD., the structure is scientific, easily support tens of millions of data, tens of millions of PV; Support visual editing, multi-dimensional expansion, full-text search, static site, SSI, dynamic page local static, URL rules completely customized for you to quickly build a site, large-scale site to provide a powerful drive, is also a good choice for enterprise project product prototype.
+PublicCMS is an open source JAVACMS system developed with mainstream technologies in 2024. Developed by Tianjin Black Core Technology Co., LTD., the structure is scientific, easily support tens of millions of data, tens of millions of PV; Support visual editing, multi-dimensional expansion, full-text search, static site, SSI, dynamic page local static, URL rules completely customized for you to quickly build a site, large-scale site to provide a powerful drive, is also a good choice for enterprise project product prototype.
 
 ## Get the source code
 

README.zh-CN.md

@@ -11,7 +11,7 @@
 
 ## 简介
 
-PublicCMS是采用2023年主流技术开发的开源JAVACMS系统。由天津黑核科技有限公司开发，架构科学，轻松支撑上千万数据、千万PV；支持可视化编辑，多维扩展，全文搜索，全站静态化，SSI，动态页面局部静态化，URL规则完全自定义等为您快速建站，建设大规模站点提供强大驱动，也是企业级项目产品原型的良好选择。
+PublicCMS是采用2024年主流技术开发的开源JAVACMS系统。由天津黑核科技有限公司开发，架构科学，轻松支撑上千万数据、千万PV；支持可视化编辑，多维扩展，全文搜索，全站静态化，SSI，动态页面局部静态化，URL规则完全自定义等为您快速建站，建设大规模站点提供强大驱动，也是企业级项目产品原型的良好选择。
 
 ## 获取源码
 

publiccms-parent/publiccms-common/src/main/java/com/publiccms/common/handler/TemplateDirectiveHandler.java

@@ -41,7 +41,6 @@ public class TemplateDirectiveHandler extends BaseHandler {
      * @param loopVars
      * @param environment
      * @param templateDirectiveBody
-     * @throws Exception
      */
     public TemplateDirectiveHandler(Map<String, TemplateModel> parameters, TemplateModel[] loopVars, Environment environment,
             TemplateDirectiveBody templateDirectiveBody) {

publiccms-parent/publiccms-common/src/main/java/com/publiccms/common/tools/ImageUtils.java

@@ -81,11 +81,11 @@ public static String getImageData(int width, int height, String text) throws IOE
     /**
      * <pre>
      * &#64;RequestMapping(value = "getCaptchaImage")
-     * public ResponseEntity<StreamingResponseBody> getCaptchaImage(HttpSession session) {
+     * public ResponseEntity&lt;StreamingResponseBody&gt; getCaptchaImage(HttpSession session) {
      *     String captcha = VerificationUtils.getRandomString("ABCDEFGHJKMNPQRSTUVWXYZ23456789", 4);
      *     session.setAttribute("captcha", captcha);
      *     StreamingResponseBody body = new StreamingResponseBody() {
-     *         @Override
+     *         &#64;Override
      *         public void writeTo(OutputStream outputStream) throws IOException {
      *             ImageUtils.drawImage(120, 30, captcha, outputStream);
      *         }

publiccms-parent/publiccms-common/src/main/java/com/publiccms/common/tools/ZipUtils.java

@@ -106,12 +106,12 @@ public static void compress(Path sourceFilePath, ArchiveOutputStream<ZipArchiveE
     /**
      * <pre>
      * &#64;RequestMapping("export")
-     * public ResponseEntity<StreamingResponseBody> export() {
+     * public ResponseEntity&lt;StreamingResponseBody&gt; export() {
      *     HttpHeaders headers = new HttpHeaders();
      *     headers.setContentDisposition(
      *             ContentDisposition.attachment().filename("filename.zip", Constants.DEFAULT_CHARSET).build());
      *     StreamingResponseBody body = new StreamingResponseBody() {
-     *         @Override
+     *         &#64;Override
      *         public void writeTo(OutputStream outputStream) throws IOException {
      *             try (ArchiveOutputStream zipOutputStream = new ZipArchiveOutputStream(outputStream)) {
      *                 ZipUtils.compressFile(new File("filename.txt"), zipOutputStream, "dir/filename.txt");

publiccms-parent/publiccms-core/src/main/java/com/publiccms/common/base/AbstractAppDirective.java

@@ -35,9 +35,7 @@ public abstract class AbstractAppDirective extends BaseHttpDirective {
     /**
      * @param handler
      * @return site
-     * @throws IOException
      * @throws TemplateModelException
-     * @throws Exception
      */
     public SysSite getSite(RenderHandler handler) throws TemplateModelException {
         return (SysSite) handler.getAttribute(CommonConstants.getAttributeSite());

publiccms-parent/publiccms-core/src/main/java/com/publiccms/common/base/AbstractTemplateDirective.java

@@ -55,8 +55,7 @@ protected SysSite getSite(RenderHandler handler) throws TemplateModelException {
     /**
      * @param model
      * @param handler
-     * @throws IOException
-     * @throws Exception
+     * @throws TemplateModelException
      */
     protected void expose(RenderHandler handler, Map<String, Object> model) throws TemplateModelException {
         AbstractFreemarkerView.exposeSite(model, getSite(handler));
@@ -106,7 +105,7 @@ public void execute(HttpMessageConverter<Object> httpMessageConverter, MediaType
     /**
      * @param handler
      * @return user
-     * @throws Exception
+     * @throws TemplateModelException
      */
     private SysUser getUser(RenderHandler handler) throws TemplateModelException {
         String authToken = handler.getString(AUTH_TOKEN);
@@ -145,8 +144,8 @@ public boolean needUserToken() {
 
     /**
      * @param handler
-     * @return
-     * @throws Exception
+     * @return app
+     * @throws TemplateModelException
      */
     protected SysApp getApp(RenderHandler handler) throws TemplateModelException {
         SysAppToken appToken = appTokenService.getEntity(handler.getString("appToken"));

publiccms-parent/publiccms-core/src/main/java/com/publiccms/common/servlet/InstallServlet.java

@@ -2,7 +2,6 @@
 
 import static com.publiccms.common.constants.Constants.DEFAULT_CHARSET_NAME;
 
-import java.beans.PropertyVetoException;
 import java.io.File;
 import java.io.FileInputStream;
 import java.io.FileOutputStream;
@@ -241,7 +240,6 @@ private static String getSiteUrl(HttpServletRequest request) {
      * @param username
      * @param password
      * @param map
-     * @throws PropertyVetoException
      * @throws SQLException
      * @throws ClassNotFoundException
      * @throws IOException
@@ -287,7 +285,6 @@ private String install(Connection connection, String username, String password,
     /**
      * 升级数据库
      * 
-     * @throws PropertyVetoException
      * @throws IOException
      * @throws SQLException
      * @throws ClassNotFoundException

publiccms-parent/publiccms-core/src/main/java/com/publiccms/common/tools/CmsFileUtils.java

@@ -339,7 +339,6 @@ private static FileUploadResult getFileSize(File file, String filename, String s
     /**
      * @param source
      * @param destination
-     * @param suffix
      * @throws IOException
      */
     public static void copyInputStreamToFile(InputStream source, String destination) throws IOException {
@@ -350,7 +349,6 @@ public static void copyInputStreamToFile(InputStream source, String destination)
     /**
      * @param source
      * @param destination
-     * @param suffix
      * @throws IOException
      */
     public static void copyFileToFile(String source, String destination) throws IOException {

publiccms-parent/publiccms-core/src/main/java/com/publiccms/common/tools/DatabaseUtils.java

@@ -1,6 +1,5 @@
 package com.publiccms.common.tools;
 
-import java.beans.PropertyVetoException;
 import java.io.IOException;
 import java.sql.Connection;
 import java.sql.DriverManager;
@@ -25,7 +24,6 @@ private DatabaseUtils() {
      * @return connection
      * @throws SQLException
      * @throws IOException
-     * @throws PropertyVetoException
      * @throws ClassNotFoundException
      */
     public static Connection getConnection(String databaseConfigFile) throws SQLException, IOException, ClassNotFoundException {

publiccms-parent/publiccms-core/src/main/java/com/publiccms/controller/admin/cms/CmsContentAdminController.java

@@ -129,7 +129,6 @@ public class CmsContentAdminController {
      * @param contentParameters
      * @param draft
      * @param checked
-     * @param bindingResult
      * @param request
      * @param model
      * @return view name

publiccms-parent/publiccms-core/src/main/java/com/publiccms/controller/admin/visit/VisitAdminController.java

@@ -58,8 +58,7 @@ public ExcelView exportHistory(@RequestAttribute SysSite site, String sessionId,
      * @param hourAnalytics
      * @param startVisitDate
      * @param endVisitDate
-     * @param orderField
-     * @param orderType
+     * @param hourAnalytics
      * @param request
      * @return view name
      */

publiccms-parent/publiccms-core/src/main/java/com/publiccms/controller/web/IndexController.java

@@ -38,8 +38,6 @@ public class IndexController {
     /**
      * METADATA页面请求统一分发
      *
-     * @param response
-     *            响应
      */
     @RequestMapping({ "/**/" + MetadataComponent.DATA_FILE, "/**/" + MetadataComponent.METADATA_FILE, "/include/*",
             "/**/" + SiteComponent.MODEL_FILE, "/**/" + SiteComponent.CATEGORY_TYPE_FILE, "/**/" + SiteComponent.CONFIG_FILE })

publiccms-parent/publiccms-core/src/main/java/com/publiccms/logic/component/config/ContentConfigComponent.java

@@ -57,8 +57,7 @@ public class ContentConfigComponent implements SiteCache, Config {
 
     /**
      * @param siteId
-     * @param config
-     * @return mail sender
+     * @return keywords config
      */
     public KeywordsConfig getKeywordsConfig(short siteId) {
         KeywordsConfig keywordsConfig = cache.get(siteId);

publiccms-parent/publiccms-core/src/main/java/com/publiccms/logic/component/template/TemplateCacheComponent.java

@@ -329,8 +329,6 @@ private String getCachedFilePath(String path) {
 
     /**
      * @param parameterTypeHandlerList
-     * @param parameterTypeHandlerMap
-     *            the parameterTypeHandlerMap to set
      */
     @Autowired
     public <E, P> void setParameterTypeHandlerMap(List<ParameterTypeHandler<E, P>> parameterTypeHandlerList) {

publiccms-parent/publiccms-core/src/main/java/com/publiccms/views/directive/api/ContentCreateDirective.java

@@ -87,8 +87,6 @@
  * <li><code>fileDescriptions</code>:多个文件描述
  * <li><code>imagePaths</code>:多个图片路径
  * <li><code>imageDescriptions</code>:多个图片描述
- * 
- * </code>:标题
  * </ul>
  * <p>
  * 返回结果

publiccms-parent/publiccms-core/src/main/java/com/publiccms/views/method/tools/GetParameterTypeListMethod.java

@@ -23,7 +23,7 @@
  * </ul>
  * 使用示例
  * <p>
- * <#list getParameterTypeList() as a>${a}<#sep>,</#list>
+ * &lt;#list getParameterTypeList() as a&gt;${a}&lt;#sep&gt;,&lt;/#list&gt;
  * <p>
  * 
  * <pre>

publiccms-parent/publiccms-oss/src/main/java/com/publiccms/logic/component/OSSComponent.java

@@ -60,8 +60,8 @@ public String getAdminContextPath() {
     }
 
     /**
-     * @param siteId
-     * @param showAll
+     * @param siteId site id
+     * @param showAll show all
      * @return config code or null
      */
     @Override
@@ -70,7 +70,7 @@ public String getCode(short siteId, boolean showAll) {
     }
 
     /**
-     * @param locale
+     * @param locale locale
      * @return
      */
     @Override

publiccms-parent/publiccms/src/main/java/config/spring/ApplicationConfig.java

@@ -1,6 +1,5 @@
 package config.spring;
 
-import java.beans.PropertyVetoException;
 import java.io.File;
 import java.io.IOException;
 import java.util.HashMap;
@@ -79,7 +78,6 @@ public void setEnvironment(Environment environment) {
      * 序列生成器
      *
      * @return idWorker
-     * @throws PropertyVetoException
      */
     @Bean
     public IdWorker idWorker() {