Skip to content
This repository was archived by the owner on Dec 4, 2025. It is now read-only.
This repository was archived by the owner on Dec 4, 2025. It is now read-only.

Fails to parse multi-line @param description formatted by Eclipse formatter #1129

Description

@CloudSen

Contact Details

www.402645063@gmail.com

Version

latest

Plugin

smart-doc-maven-plugin

Build tool version

maven 3.9.10

Jdk version

21

Describe the bug (Bug描述,社区已开启国际化推广,请用千问、星火等免费大模型工具辅助翻译成英文,减少社区开发者的工作)

When using the Eclipse Javadoc formatter, the formatter automatically wraps @param descriptions into multiple lines with indentation.

/**
   * get user detail by user id
   *
   * @param userId
   *            employee id for user   ###### NOTE: description is new line
   * @return user details
   */

In this case, Smart-Doc fails to recognize the parameter description, resulting in error :

ERROR: Unable to find javadoc @param for actual param "userId" in method xxxx

This issue makes it impossible for teams that enforce Eclipse-style formatting rules to use Smart-Doc without patching or reformatting the source.

Expected Behavior (您期望的结果,社区已开启国际化推广,请用千问、星火等免费大模型工具辅助翻译成英文,减少社区开发者的工作)

Smart-Doc should automatically merge the following line(s) that are indented and directly follow @PARAM , treating them as the continuation of the description.
For example:

@param userId
        employee id for user 
@param orgID
        orgnization id for user

Current Behavior (当前结果,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

ERROR: Unable to find javadoc @PARAM for actual param "userId" in method xxxx

Steps to Reproduce (Bug产生步骤,请尽量提供用例代码。社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

  1. just comment with this javadoc
/**
   * get user detail by user id
   *
   * @param userId
   *            employee id for user   ###### NOTE: description is new line
   * @return user details
   */
  1. execute maven plugin : mvn -Dfile.encoding=UTF-8 smart-doc:torna-rest

Possible Solution (Bug解决建议,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Context (Bug影响描述,社区已开启国际化推广,请用文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Validations

  • Check if you're on the latest smart-doc version. (请检查是否为最新版本)
  • Read the docs. (请先阅读官方文档)
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. (检查是否存在报告相同错误的问题,以避免产生重复)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions