{"id":37019247,"url":"https://github.com/geningxiang/javadoc-help","last_synced_at":"2026-01-14T02:04:23.293Z","repository":{"id":37134785,"uuid":"174633794","full_name":"geningxiang/javadoc-help","owner":"geningxiang","description":"JavaDoc工具 解析Java源码注释，生成api文档、接口文档","archived":false,"fork":false,"pushed_at":"2022-12-16T15:30:54.000Z","size":511,"stargazers_count":13,"open_issues_count":16,"forks_count":6,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-07-09T01:46:23.107Z","etag":null,"topics":["apidoc","doc","java","javadoc","swagger"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/geningxiang.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-03-09T01:24:37.000Z","updated_at":"2024-01-25T03:22:51.000Z","dependencies_parsed_at":"2023-01-29T14:45:49.499Z","dependency_job_id":null,"html_url":"https://github.com/geningxiang/javadoc-help","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/geningxiang/javadoc-help","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geningxiang%2Fjavadoc-help","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geningxiang%2Fjavadoc-help/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geningxiang%2Fjavadoc-help/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geningxiang%2Fjavadoc-help/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/geningxiang","download_url":"https://codeload.github.com/geningxiang/javadoc-help/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/geningxiang%2Fjavadoc-help/sbom","scorecard":{"id":422522,"data":{"date":"2025-08-11","repo":{"name":"github.com/geningxiang/javadoc-help","commit":"f1a8caa7e3641c15cab1caaddeccbb4fa6d08ba6"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: Apache License 2.0: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":0,"reason":"69 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-vmq6-5m68-f53m","Warn: Project is vulnerable to: GHSA-668q-qrv7-99fm","Warn: Project is vulnerable to: GHSA-6v67-2wr5-gvf4","Warn: Project is vulnerable to: GHSA-pr98-23f8-jwxv","Warn: Project is vulnerable to: GHSA-pv7h-hx5h-mgfj","Warn: Project is vulnerable to: GHSA-h46c-h94j-95f3","Warn: Project is vulnerable to: GHSA-wf8f-6423-gfxg","Warn: Project is vulnerable to: GHSA-288c-cq4h-88gq","Warn: Project is vulnerable to: GHSA-3x8x-79m2-3w2w","Warn: Project is vulnerable to: GHSA-57j2-w4cx-62h2","Warn: Project is vulnerable to: GHSA-jjjh-jjxp-wpff","Warn: Project is vulnerable to: GHSA-rgv9-q543-rqg4","Warn: Project is vulnerable to: GHSA-5mg8-w23w-74h3","Warn: Project is vulnerable to: GHSA-7g45-4rm6-3mm3","Warn: Project is vulnerable to: GHSA-78wr-2p64-hpwj","Warn: Project is vulnerable to: GHSA-gwrp-pvrq-jmwv","Warn: Project is vulnerable to: GHSA-j288-q9x7-2f5v","Warn: Project is vulnerable to: GHSA-27hp-xhwr-wr2m","Warn: Project is vulnerable to: GHSA-2rvv-w9r2-rg7m","Warn: Project is vulnerable to: GHSA-5j33-cvvr-w245","Warn: Project is vulnerable to: GHSA-7w75-32cg-r6g2","Warn: Project is vulnerable to: GHSA-83qj-6fr2-vhqg","Warn: Project is vulnerable to: GHSA-fccv-jmmp-qg76","Warn: Project is vulnerable to: GHSA-g8pj-r55q-5c2v","Warn: Project is vulnerable to: GHSA-h2fw-rfh5-95r3","Warn: Project is vulnerable to: GHSA-h3gc-qfqq-6h8f","Warn: Project is vulnerable to: GHSA-hfrx-6qgj-fp6c","Warn: Project is vulnerable to: GHSA-j39c-c8hj-x4j3","Warn: Project is vulnerable to: GHSA-jgwr-3qm3-26f3","Warn: Project is vulnerable to: GHSA-p22x-g9px-3945","Warn: Project is vulnerable to: GHSA-q3mw-pvr8-9ggc","Warn: Project is vulnerable to: GHSA-qppj-fm5r-hxr3","Warn: Project is vulnerable to: GHSA-r6j3-px5g-cq3x","Warn: Project is vulnerable to: GHSA-wc4r-xq3c-5cf3","Warn: Project is vulnerable to: GHSA-wm9w-rjj3-j356","Warn: Project is vulnerable to: GHSA-v682-8vv8-vpwr","Warn: Project is vulnerable to: GHSA-v6w3-2prq-h95f","Warn: Project is vulnerable to: GHSA-7v6m-28jr-rg84","Warn: Project is vulnerable to: GHSA-rmrm-75hp-phr2","Warn: Project is vulnerable to: GHSA-x83m-pf6f-pf9g","Warn: Project is vulnerable to: GHSA-cm59-pr5q-cw85","Warn: Project is vulnerable to: GHSA-rc42-6c7j-7h5r","Warn: Project is vulnerable to: GHSA-xf96-w227-r7c4","Warn: Project is vulnerable to: GHSA-36p3-wjmg-h94x","Warn: Project is vulnerable to: GHSA-hh26-6xwr-ggv7","Warn: Project is vulnerable to: GHSA-4gc7-5j7h-4qph","Warn: Project is vulnerable to: GHSA-4wp7-92pw-q264","Warn: Project is vulnerable to: GHSA-g5mm-vmx4-3rg7","Warn: Project is vulnerable to: GHSA-6gf2-pvqw-37ph","Warn: Project is vulnerable to: GHSA-rfmp-97jj-h8m6","Warn: Project is vulnerable to: GHSA-558x-2xjg-6232","Warn: Project is vulnerable to: GHSA-564r-hj7v-mcr5","Warn: Project is vulnerable to: GHSA-9cmq-m9j5-mvww","Warn: Project is vulnerable to: GHSA-wxqc-pxw9-g2p8","Warn: Project is vulnerable to: GHSA-2rmj-mq67-h97g","Warn: Project is vulnerable to: GHSA-2wrp-6fg6-hmc5","Warn: Project is vulnerable to: GHSA-4wrc-f8pq-fpqp","Warn: Project is vulnerable to: GHSA-ccgv-vj62-xf9h","Warn: Project is vulnerable to: GHSA-gfwj-fwqj-fp3v","Warn: Project is vulnerable to: GHSA-hgjh-9rj2-g67j","Warn: Project is vulnerable to: GHSA-g5vr-rgqm-vf78","Warn: Project is vulnerable to: GHSA-3mc7-4q67-w48m","Warn: Project is vulnerable to: GHSA-98wm-3w3q-mw94","Warn: Project is vulnerable to: GHSA-9w3m-gqgf-c4p9","Warn: Project is vulnerable to: GHSA-c4r9-r8fh-9vj2","Warn: Project is vulnerable to: GHSA-hhhw-99gj-p3c3","Warn: Project is vulnerable to: GHSA-mjmj-j48q-9wg2","Warn: Project is vulnerable to: GHSA-rvwf-54qp-4r6v","Warn: Project is vulnerable to: GHSA-w37g-rhq8-7m4j"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-19T01:34:27.471Z","repository_id":37134785,"created_at":"2025-08-19T01:34:27.471Z","updated_at":"2025-08-19T01:34:27.471Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28408711,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T01:52:23.358Z","status":"online","status_checked_at":"2026-01-14T02:00:06.678Z","response_time":107,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["apidoc","doc","java","javadoc","swagger"],"created_at":"2026-01-14T02:04:22.553Z","updated_at":"2026-01-14T02:04:23.288Z","avatar_url":"https://github.com/geningxiang.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# javadoc-help\n\n#### 先来看一段代码\n````\n    /**\n     * 用户登录\n     * @param userName 用户名 {@link User#getUserName()}\n     * @param passWord 密码 {@link User#getPassWord()}\n     */\n    @RequestMapping(value = \"/login\", method = RequestMethod.POST, produces = \"application/json;charset=UTF-8\")\n    public ResponseEntity\u003cUser\u003e login(\n            @Validated\n            @NotEmpty String userName,\n            @Validated\n            @NotBlank\n            @Pattern(regexp = \"/^(?![0-9]+$)(?![a-zA-Z]+$)[0-9A-Za-z]{6,10}$/\", message = \"密码必须是6~10位数字和字母的组合\")\n                    String passWord) {\n        ......\n    }\n````\n\n#### 再来看看效果图\n![](https://panda007.gitee.io/static/javadoc/demo.png)\n\n### [Demo1](https://panda007.gitee.io/static/javadoc/index.html)\n\n### [Demo2 for macrozheng/mall-portal ](https://panda007.gitee.io/static/javadoc/mall-portal/index.html)\n\n### [Demo3 for macrozheng/mall-admin ](https://panda007.gitee.io/static/javadoc/mall-admin/index.html)\n\n\n\n### 版本说明\n\n| 版本号 | 说明 |\n| :----: | ------ |\n| 1.0.0 | 完成基础解析功能 |\n| 1.1.0 | 添加泛型解析，新增解析结果的实体类(后续将要持久化) |\n| 1.1.1 | 定义插件，解析各种注解(lombok、jsr-305) |\n| 2.0.0 | 重写整个javadoc解析,优化界面 |\n\n### MAVEN\nmaven中央仓库更新太麻烦,还没能上传新版本\n```\n\u003cplugin\u003e\n    \u003cgroupId\u003ecom.github.geningxiang\u003c/groupId\u003e\n    \u003cartifactId\u003ejavadoc-mvn-plugin\u003c/artifactId\u003e\n    \u003cversion\u003e1.1.2\u003c/version\u003e\n\u003c/plugin\u003e\n```\n````\n\u003cplugins\u003e\n    \u003cplugin\u003e\n        \u003cgroupId\u003ecom.github.geningxiang\u003c/groupId\u003e\n        \u003cartifactId\u003ejavadoc-mvn-plugin\u003c/artifactId\u003e\n        \u003cversion\u003e2.0.0-SNAPSHOT\u003c/version\u003e\n        \u003cconfiguration\u003e\n            \u003c!-- 读取关联依赖的源码 --\u003e\n            \u003cimportSourceDirs\u003e\n                \u003cimportSourceDir\u003e${basedir}/../mall-common/\u003c/importSourceDir\u003e\n                \u003cimportSourceDir\u003e${basedir}/../mall-mbg/\u003c/importSourceDir\u003e\n                \u003cimportSourceDir\u003e${basedir}/../mall-search/\u003c/importSourceDir\u003e\n                \u003cimportSourceDir\u003e${basedir}/../mall-security/\u003c/importSourceDir\u003e\n            \u003c/importSourceDirs\u003e\n        \u003c/configuration\u003e\n    \u003c/plugin\u003e\n\u003c/plugins\u003e\n````\n\n运行插件前需要对项目先做一次package\n```\nmvn clean package -Dmaven.test.skip=true\n\nmvn javadoc-mvn:javaDoc\n```\n\n###规划中\n- 在页面上能够跳转到关联注释 @see | {@link} | {@linkPlan}\n- JavaDoc、RestApiDoc对象序列化后向配置的接口地址发送\n- 与 [automate2](https://gitee.com/panda007/automate2) 结合,作为一个独立的JAVA接口管理模块;  \n  为项目相关人员实时推送Java接口变动及Rest接口变动,并提供版本之间的差异比较功能\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeningxiang%2Fjavadoc-help","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgeningxiang%2Fjavadoc-help","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgeningxiang%2Fjavadoc-help/lists"}