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

Using @see annotation with content other than an enumeration class name results in a runtime error. #340

Closed
wenyuantc opened this issue Sep 3, 2022 · 1 comment
Labels
bug Something isn't working

Comments

@wenyuantc
Copy link

wenyuantc commented Sep 3, 2022

First use, an error occurred while generating the documentation.

Your Environment(Your Using Environment)

  • smart-doc version: 2.5.1
  • plugin version (e.g. smart-doc-maven-plugin or smart-doc-gradle-plugin): smart-doc-maven-plugin
  • build tool version(maven or gradle): maven
  • smart-doc.json configuration:
{
  "outPath": "src/main/resources/static/apiDoc"
}

Expected Behavior(Expected Outcome)

Generate HTML documents.

Current Behavior(Current Outcome)

An exception occurs: java.lang.RuntimeException: enum not existed

Steps to Reproduce (Steps to Generate the Bug, Please Provide Code Examples if Possible)

Describe in detail the steps to reproduce this issue.

@wenyuantc wenyuantc added the bug Something isn't working label Sep 3, 2022
@shalousun
Copy link
Collaborator

shalousun commented Sep 3, 2022

@wenyuantc It seems that you have a field marked with @see, but the content is empty.

@shalousun shalousun changed the title 执行smart-doc:html报错 使用@see注释内容不是枚举类名运行错误 Sep 3, 2022
@shalousun shalousun changed the title 使用@see注释内容不是枚举类名运行错误 Using @see annotation with content other than an enumeration class name results in a runtime error. Jun 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

2 participants