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

Method-Level Documentation Filtering  #1073

@linwumingshi

Description

@linwumingshi

Is your feature request related to a problem? Please describe.(关于这个PR的描述,社区已开启国际化推广,请文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

smart-doc currently lacks the ability to filter specific methods during documentation generation. This feature would allow users to dynamically exclude methods based on custom criteria (e.g., naming conventions, configuration rules) without modifying source code.

Basic example (PR的用例,社区已开启国际化推广,请文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

	default boolean skipMethod(final JavaClass cls, final JavaMethod method, ApiConfig apiConfig,
			ProjectDocConfigBuilder projectBuilder) {
		return true;
	}

Describe the solution you'd like (描述您想要的解决方案,社区已开启国际化推广,请文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

  • Add skipMethod default method to IJavadocDocTemplate
  • Integrate filter check in buildServiceMethod processing flow
  • Provide complete context (class/method/config) for flexible filtering logic

Describe alternatives you've considered (描述你考虑过的替代方案,社区已开启国际化推广,请文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Additional context (其他背景信息,社区已开启国际化推广,请文心一言、讯飞星火等辅助翻译成英文,减少社区开发者的工作)

No response

Validations

  • Read the docs. (请先阅读官方文档)
  • Read the Contributing Guidelines. (请先阅读官方文档·贡献指南)
  • Check that there isn't already an issue that reports the same bug to avoid creating a duplicate. (检查是否存在报告相同错误的问题,以避免产生重复)

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