Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

When the project's Javadoc is not properly formatted How can I generate API documentation without making any modifications to the project #854

Open
3 tasks done
KiRito02 opened this issue Jul 18, 2024 · 1 comment

Comments

@KiRito02
Copy link

Contact Details

No response

Version

3.05

Plugin

smart-doc-maven-plugin

Build tool version

3.8

Jdk version

1.8

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

When the project's Javadoc is not properly formatted, such as missing values after tags like @author or @param, smart-doc will throw an error and terminate the generation process. How can I generate API documentation without making any modifications to the project?

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

generate documentation without modifying project files

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

When smart-doc generates documentation, it will throw an error and terminate the generation process.

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

bad javadoc like this:
/**
*@author
*@param
*@return
**/

When smart-doc generates documentation, it will throw an error and terminate the generation process.

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.
@shalousun
Copy link
Collaborator

Unsupported, because the design philosophy of smart-doc mandates that teams must follow comments standards, resulting in strict checks. We also do not want to loosen the configuration as it would make it difficult for developers to adhere to these standardized norms.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants