{"id":16620024,"url":"https://github.com/mattbertolini/jxr-ant","last_synced_at":"2026-05-30T22:31:31.410Z","repository":{"id":3698993,"uuid":"4769928","full_name":"mattbertolini/JXR-Ant","owner":"mattbertolini","description":"An Ant task for the JXR report. Based on the JXR Maven plugin.","archived":false,"fork":false,"pushed_at":"2020-09-27T15:26:00.000Z","size":55,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-01-17T22:09:24.014Z","etag":null,"topics":["ant","ant-task","java","jxr","jxr-ant"],"latest_commit_sha":null,"homepage":null,"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/mattbertolini.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":"2012-06-24T04:38:23.000Z","updated_at":"2023-10-01T06:55:03.000Z","dependencies_parsed_at":"2022-09-26T16:20:26.542Z","dependency_job_id":null,"html_url":"https://github.com/mattbertolini/JXR-Ant","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattbertolini%2FJXR-Ant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattbertolini%2FJXR-Ant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattbertolini%2FJXR-Ant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mattbertolini%2FJXR-Ant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mattbertolini","download_url":"https://codeload.github.com/mattbertolini/JXR-Ant/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242988270,"owners_count":20217579,"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":["ant","ant-task","java","jxr","jxr-ant"],"created_at":"2024-10-12T02:43:18.448Z","updated_at":"2025-12-12T05:33:16.123Z","avatar_url":"https://github.com/mattbertolini.png","language":"Java","funding_links":[],"categories":[],"sub_categories":[],"readme":"# JXR Ant Task\n\nVersion 2.1.0\u003cbr/\u003e\nWritten by Matt Bertolini\n\n[![Maven Central](https://maven-badges.herokuapp.com/maven-central/com.mattbertolini/jxr-ant/badge.svg)](https://maven-badges.herokuapp.com/maven-central/com.mattbertolini/jxr-ant)\n\n## License\n\nThe JXR Ant Task is licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0).\n\n## Usage\n\nDownload the library from [Maven Central](http://search.maven.org/#search|ga|1|g%3A%22com.mattbertolini%22%20a%3A%22jxr-ant%22) and make sure it is available to ant in some way (e.g. On Ant's classpath or in a `\u003cpath\u003e`).\n\nMaven:\n```xml\n\u003cdependency\u003e\n    \u003cgroupId\u003ecom.mattbertolini\u003c/groupId\u003e\n    \u003cartifactId\u003ejxr-ant\u003c/artifactId\u003e\n    \u003cversion\u003e2.1.0\u003c/version\u003e\n\u003c/dependency\u003e\n```\n\nIvy:\n```xml\n\u003cdependency org=\"com.mattbertolini\" name=\"jxr-ant\" rev=\"2.1.0\"/\u003e\n```\n\nIn your ant file, load the task.\n\n```xml\n\u003ctaskdef resource=\"com/mattbertolini/jxr/ant/antlib.xml\"/\u003e\n```\n\n## Parameters\n\n\u003ctable\u003e\n  \u003ctr\u003e\n    \u003cth\u003eAttribute\u003c/th\u003e\n    \u003cth\u003eDescription\u003c/th\u003e\n    \u003cth\u003eAvailability\u003c/th\u003e\n    \u003cth\u003eRequired\u003c/th\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003ebottom\u003c/td\u003e\n    \u003ctd\u003eThe text or HTML to place at the footer of the generated files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo.\u003c/td\u003e\n  \u003ctr\u003e\n    \u003ctd\u003edestdir\u003c/td\u003e\n    \u003ctd\u003eThe destination directory where the generated files are saved.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eYes\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003edoctitle\u003c/td\u003e\n    \u003ctd\u003eThe document title to give the generated files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo. Defaults to ${project.name} Xref Documentation\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003einputencoding\u003c/td\u003e\n    \u003ctd\u003eThe character set to use when reading the input/source files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo. Defaults to JVM file.encoding system property.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003ejavadocdir\u003c/td\u003e\n    \u003ctd\u003eThe directory where the equivalient javadoc files are located. Adding this attribute will link the javadoc with\n    the xref files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003eoutputencoding\u003c/td\u003e\n    \u003ctd\u003eThe character set to use when writing the generated files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo. Defaults to JVM file.encoding system property.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003esourcepath\u003c/td\u003e\n    \u003ctd\u003eThe directory where the source files are located.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eYes unless a nested \u0026lt;sourcepath\u0026gt; is given.\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003estylesheet\u003c/td\u003e\n    \u003ctd\u003eThe file path to the custom stylesheet to use when generating the documentation.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003etemplatedir\u003c/td\u003e\n    \u003ctd\u003eThe directory where the custom templates are located.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo\u003c/td\u003e\n  \u003c/tr\u003e\n  \u003ctr\u003e\n    \u003ctd\u003ewindowtitle\u003c/td\u003e\n    \u003ctd\u003eThe window title to give the generated HTML files.\u003c/td\u003e\n    \u003ctd\u003eall\u003c/td\u003e\n    \u003ctd\u003eNo. Defaults to ${project.name} Xref Documentation.\u003c/td\u003e\n  \u003c/tr\u003e\n\u003c/table\u003e\n\n## Parameters defined as nested elements\n\n### bottom\n\nSame as the bottom attribute. Nested element allows for easier defining of large blocks of text or HTML.\n\n### doctitle\n\nSame as the doctitle attribute.\n\n### Sourcepath\n\nA Path. This element allows for multiple source paths to be combined and generated into the final generated\ndocumentation. All path elements must be directories. No individual files can be listed in the path. If defined, the\nsourcepath attribute is not needed.\n\n### windowtitle\n\nThe same as the window title attribute.\n\n## Examples\n\nHere is a basic uasage example:\n\n```xml\n\u003cjxr destdir=\"dest/docs/jxr\" sourcepath=\"src\"/\u003e\n```\n\nHere is an example using the `\u003csourcepath\u003e` nested element instead of the attribute:\n\n```xml\n\u003cjxr destdir=\"dest/docs/jxr/\"\u003e\n    \u003csourcepath\u003e\n        \u003cpathelement location=\"src\"/\u003e\n    \u003c/sourcepath\u003e\n\u003c/jxr\u003e\n```\n\nHere is an example with an HTML footer defined in the `\u003cbottom\u003e` nested element:\n\n```xml\n\u003cjxr destdir=\"dest/docs/jxr\" sourcepath=\"src\"\u003e\n    \u003cbottom\u003e\u003c![CDATA[\u003cp\u003eFooter text here\u003c/p\u003e]]\u003e\u003c/bottom\u003e\n\u003c/jxr\u003e\n```\n\nHere is an example with some classes excluded using a `\u003cpatternset\u003e` element:\n\n```xml\n\u003cjxr destdir=\"dest/docs/jxr\" sourcepath=\"src\"\u003e\n    \u003cpatternset\u003e\n        \u003cexcludes name=\"**/example/subpackage/**\"/\u003e\n    \u003c/patternset\u003e\n\u003c/jxr\u003e\n```\n\n### Gradle\n\nSince Ant tasks are [first-class citizens](http://www.gradle.org/docs/current/userguide/ant.html) in Gradle, adding\nJXR-Ant to a gradle build is very easy. To start add the JXR-Ant dependency to the dependencies section. It is\nrecommended you create a special configuration for the library:\n\n```groovy\nconfigurations {\n    jxr\n}\ndependencies {\n    jxr group: 'com.mattbertolini', name: 'jxr-ant', version: '2.1.0'\n}\n```\n\nNext, define the ant task an invoke it:\n\n```groovy\ntask runJxr() {\n    ant.taskdef(resource: 'com/mattbertolini/jxr/ant/antlib.xml', classpath: configurations.jxr.asPath)\n    ant.jxr(destDir: \"$docsDir/jxr\", sourcePath: files(sourceSets.main.java.srcDirs).asPath)\n}\n```\n\nHere is a more complex example:\n\n```groovy\ntask runJxr(dependsOn: 'javadoc') {\n    ant.taskdef(resource: 'com/mattbertolini/jxr/ant/antlib.xml', classpath: configurations.jxr.asPath)\n    ant.jxr(destDir: \"$docsDir/jxr\", sourcePath: files(sourceSets.main.java.srcDirs).asPath, javadocDir: \"$docsDir/javadoc\") {\n        bottom('\u003cp\u003eFooter text here\u003c/p\u003e')\n        patternset(excludes: '**/example/subpackage/**')\n    }\n}\n```\n\n## Build and Test\n### Requirements\n* [Apache Ant](http://ant.apache.org/) - Version 1.8 or higher.\n* JDK 6 or higher (Compiled with 1.6 source and target).\n\n### Build\nTo build this project, clone the repo and run the ```ant``` command:\n```\n$ git clone https://github.com/mattbertolini/JXR-Ant.git\n$ cd JXR-Ant\n$ ant\n```\n\nThe distributable jar files will be located in the ```dist``` folder. The build reports (unit test, dependency,\ncoverage, etc.) will be located in the ```build/reports``` dir.\n\nTo run the unit tests run the ```run-unit-tests``` task.\n```\n$ ant run-unit-tests\n```\n\n## Bugs\n\nIf you find any bugs, please file them in the issue tracker above. Patches and pull requests are encouraged.\n\n## Release Notes\n\n**3.0.0.dev - In development. Not yet released.**\n\n* Minimum Java version now at 1.7.\n* Updated build dependencies (JUnit, JaCoCo, Findbugs, etc).\n\n**2.1.0 - 2014-11-16**\n\n* Updating JXR dependency to 2.5. Backward compatible.\n\n**2.0.0 - 2013-12-20**\n\n* Updating JXR dependency to version 2.4.\n\n**1.0.0 - 2012-06-24**\n\n* Initial release.\n* Uses JXR version 2.3\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattbertolini%2Fjxr-ant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmattbertolini%2Fjxr-ant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmattbertolini%2Fjxr-ant/lists"}