{"id":15677692,"url":"https://github.com/chhorz/javadoc-parser","last_synced_at":"2025-04-16T03:44:19.486Z","repository":{"id":29149154,"uuid":"123159871","full_name":"chhorz/javadoc-parser","owner":"chhorz","description":"Java library for parsing information from a structured Javadoc string.","archived":false,"fork":false,"pushed_at":"2024-04-08T17:02:15.000Z","size":450,"stargazers_count":13,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-04-08T21:18:03.659Z","etag":null,"topics":["java","javadoc"],"latest_commit_sha":null,"homepage":"","language":"CSS","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/chhorz.png","metadata":{"files":{"readme":"README.adoc","changelog":null,"contributing":"CONTRIBUTING.adoc","funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2018-02-27T16:53:15.000Z","updated_at":"2024-04-15T15:50:41.381Z","dependencies_parsed_at":"2023-12-18T18:47:20.433Z","dependency_job_id":"214f29bf-c173-4148-bd8a-1e87dacba2bb","html_url":"https://github.com/chhorz/javadoc-parser","commit_stats":null,"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Fjavadoc-parser","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Fjavadoc-parser/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Fjavadoc-parser/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/chhorz%2Fjavadoc-parser/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/chhorz","download_url":"https://codeload.github.com/chhorz/javadoc-parser/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249191933,"owners_count":21227683,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["java","javadoc"],"created_at":"2024-10-03T16:10:17.675Z","updated_at":"2025-04-16T03:44:19.456Z","avatar_url":"https://github.com/chhorz.png","language":"CSS","funding_links":[],"categories":[],"sub_categories":[],"readme":"= Javadoc Parser\n:author: Christian Horz\n:icons: font\n\nimage:https://github.com/chhorz/javadoc-parser/actions/workflows/maven-ci.yml/badge.svg?branch=master[\"Java CI\", link=\"https://github.com/chhorz/javadoc-parser/actions/workflows/maven-ci.yml\"]\nimage:https://img.shields.io/maven-central/v/com.github.chhorz/javadoc-parser.svg?logo=apachemaven\u0026label=Maven%20Central[\"Maven Central\", link=\"https://search.maven.org/artifact/com.github.chhorz/javadoc-parser\"]\n\n== About\nThis library provides a parsing mechanism for *Javadoc* comments within java files.\nAn initial documentation of the Javadoc tool can be found on the pages of Oracle: link:http://www.oracle.com/technetwork/java/javase/documentation/index-jsp-135444.html[Javadoc Tool].\n\nTo get the parsing mechanism work properly the Javadoc comment has to follow a specific structure.\nThe structure should be as close as possible to the link:http://www.oracle.com/technetwork/articles/java/index-137868.html[Writers Guide] from Oracle.\n\n== Usage\nThe project is available from maven central repository:\n\n[source,xml]\n----\n\u003cdependency\u003e\n  \u003cgroupId\u003ecom.github.chhorz\u003c/groupId\u003e\n  \u003cartifactId\u003ejavadoc-parser\u003c/artifactId\u003e\n  \u003cversion\u003e${javadoc-parser.version}\u003c/version\u003e\n\u003c/dependency\u003e\n----\n\nInformation about the latest published version is available on the link:https://github.com/chhorz/javadoc-parser/releases[GitHub Releases] page.\n\n=== Javadoc comment structure\n_work in progress_\n\n=== Parser configuration\n\n.Parsing\n[source,java]\n----\nJavaDocParser javaDocParser = JavaDocParserBuilder\n\t\t.withStandardJavadocTags()\n\t\t.withOutputType(OutputType.PLAIN)\n\t\t.build();\n\nJavaDoc javaDoc = javaDocParser.parse(\"Javadoc as String\");\n----\n\n=== Retrieving data\n\n.Getting data\n[source,java]\n----\nList\u003cAuthorTag\u003e authorTags = javaDoc.getTags(AuthorTag.class);\n\nAuthorTag firstAuthor = authorTags.get(0);\n\nfirstAuthor.getNameText();\n----\n\n== Snapshots\nSnapshots are available from the Sonatype OSS Snapshots repository.\nTo configure the repository for your project to use the latest snapshot versions you have to add the following repository to your maven pom:\n[source,xml]\n----\n\u003crepositories\u003e\n    \u003crepository\u003e\n        \u003cid\u003eossrh\u003c/id\u003e\n        \u003curl\u003ehttps://oss.sonatype.org/content/repositories/snapshots\u003c/url\u003e\n    \u003c/repository\u003e\n\u003c/repositories\u003e\n----\n\n== License\nJavadoc Parser is open source software released under the link:http://www.apache.org/licenses/LICENSE-2.0.txt[Apache 2.0 license].\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchhorz%2Fjavadoc-parser","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchhorz%2Fjavadoc-parser","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchhorz%2Fjavadoc-parser/lists"}