├── .asf.yaml
├── .github
├── ISSUE_TEMPLATE
│ ├── BUG.yml
│ ├── FEATURE.yml
│ └── config.yml
├── dependabot.yml
├── pull_request_template.md
├── release-drafter.yml
└── workflows
│ ├── maven-verify.yml
│ ├── pr-automation.yml
│ ├── release-drafter.yml
│ └── stale.yml
├── .gitignore
├── Jenkinsfile
├── README.md
├── deploySite.sh
├── maven-jxr-plugin
├── pom.xml
└── src
│ ├── it
│ ├── JXR-100_parameterlink
│ │ ├── invoker.properties
│ │ ├── pom.xml
│ │ ├── src
│ │ │ └── main
│ │ │ │ └── java
│ │ │ │ └── com
│ │ │ │ └── mycompany
│ │ │ │ └── app
│ │ │ │ ├── App.java
│ │ │ │ └── Foo.java
│ │ └── verify.groovy
│ ├── JXR-135_innerclasses
│ │ ├── invoker.properties
│ │ ├── pom.xml
│ │ └── src
│ │ │ └── main
│ │ │ └── java
│ │ │ └── com
│ │ │ └── mycompany
│ │ │ └── app
│ │ │ └── ClassWithNested.java
│ ├── JXR-143_nofork
│ │ ├── invoker.properties
│ │ ├── pom.xml
│ │ ├── src
│ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it
│ │ │ │ └── AppTest.java
│ │ └── verify.groovy
│ ├── aggregate
│ │ ├── p1
│ │ │ ├── pom.xml
│ │ │ └── src
│ │ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it
│ │ │ │ └── AppTest.java
│ │ ├── p2
│ │ │ ├── pom.xml
│ │ │ └── src
│ │ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it2
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it2
│ │ │ │ └── AppTest.java
│ │ ├── pom.xml
│ │ └── verify.groovy
│ ├── mixed-plugin-report
│ │ ├── p1
│ │ │ ├── pom.xml
│ │ │ └── src
│ │ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it
│ │ │ │ └── AppTest.java
│ │ ├── p2
│ │ │ ├── pom.xml
│ │ │ └── src
│ │ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it2
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it2
│ │ │ │ └── AppTest.java
│ │ ├── pom.xml
│ │ └── verify.groovy
│ ├── new-site-config
│ │ ├── pom.xml
│ │ ├── src
│ │ │ ├── main
│ │ │ │ └── java
│ │ │ │ │ └── org
│ │ │ │ │ └── apache
│ │ │ │ │ └── maven
│ │ │ │ │ └── jxr
│ │ │ │ │ └── it
│ │ │ │ │ ├── App.java
│ │ │ │ │ └── App2.java
│ │ │ └── test
│ │ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it
│ │ │ │ └── AppTest.java
│ │ └── verify.groovy
│ ├── settings.xml
│ └── simple-project
│ │ ├── pom.xml
│ │ ├── src
│ │ ├── main
│ │ │ └── java
│ │ │ │ └── org
│ │ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── jxr
│ │ │ │ └── it
│ │ │ │ ├── App.java
│ │ │ │ └── App2.java
│ │ └── test
│ │ │ └── java
│ │ │ └── org
│ │ │ └── apache
│ │ │ └── maven
│ │ │ └── jxr
│ │ │ └── it
│ │ │ └── AppTest.java
│ │ └── verify.groovy
│ ├── main
│ ├── java
│ │ └── org
│ │ │ └── apache
│ │ │ └── maven
│ │ │ └── plugin
│ │ │ └── jxr
│ │ │ ├── AbstractJxrReport.java
│ │ │ ├── AggregatorJxrReport.java
│ │ │ ├── AggregatorJxrTestReport.java
│ │ │ ├── JxrNoForkReport.java
│ │ │ ├── JxrReport.java
│ │ │ ├── JxrReportUtil.java
│ │ │ ├── JxrTestNoForkReport.java
│ │ │ └── JxrTestReport.java
│ └── resources
│ │ ├── jdk4
│ │ └── stylesheet.css
│ │ ├── jdk6
│ │ └── stylesheet.css
│ │ ├── jdk7
│ │ ├── resources
│ │ │ ├── background.gif
│ │ │ ├── tab.gif
│ │ │ ├── titlebar.gif
│ │ │ └── titlebar_end.gif
│ │ └── stylesheet.css
│ │ ├── jdk8
│ │ └── stylesheet.css
│ │ ├── jxr-report.properties
│ │ ├── jxr-report_de.properties
│ │ ├── jxr-report_el.properties
│ │ ├── jxr-report_en.properties
│ │ ├── jxr-report_fr.properties
│ │ ├── jxr-report_sv.properties
│ │ └── stylesheet.css
│ ├── site
│ ├── apt
│ │ ├── examples
│ │ │ ├── aggregate.apt.vm
│ │ │ ├── include-exclude.apt.vm
│ │ │ ├── linkjavadoc.apt.vm
│ │ │ └── nofork.apt.vm
│ │ ├── index.apt
│ │ └── usage.apt.vm
│ ├── fml
│ │ └── faq.fml
│ ├── resources
│ │ └── example
│ │ │ ├── jxr.html
│ │ │ └── xref
│ │ │ ├── allclasses-frame.html
│ │ │ ├── index.html
│ │ │ ├── org
│ │ │ └── apache
│ │ │ │ └── maven
│ │ │ │ └── plugin
│ │ │ │ └── jxr
│ │ │ │ ├── JxrReport.html
│ │ │ │ ├── PluginLogAdapter.html
│ │ │ │ ├── package-frame.html
│ │ │ │ └── package-summary.html
│ │ │ ├── overview-frame.html
│ │ │ ├── overview-summary.html
│ │ │ └── stylesheet.css
│ └── site.xml
│ └── test
│ ├── java
│ └── org
│ │ └── apache
│ │ └── maven
│ │ └── plugin
│ │ └── jxr
│ │ ├── AbstractJxrTestCase.java
│ │ ├── DependencyArtifactStubFactory.java
│ │ ├── JxrReportTest.java
│ │ ├── JxrTestReportTest.java
│ │ └── stubs
│ │ ├── AggregateSubmodule1MavenProjectStub.java
│ │ ├── AggregateSubmodule2MavenProjectStub.java
│ │ ├── AggregateTestMavenProjectStub.java
│ │ ├── DefaultArtifactHandlerStub.java
│ │ ├── DefaultConfigurationMavenProjectStub.java
│ │ ├── ExcludeConfigurationMavenProjectStub.java
│ │ ├── IncludeConfigurationMavenProjectStub.java
│ │ ├── JxrPluginArtifactStub.java
│ │ ├── JxrProjectStub.java
│ │ ├── NoJavadocDirMavenProjectStub.java
│ │ ├── NoJavadocLinkConfigurationMavenProjectStub.java
│ │ ├── PomMavenProjectStub.java
│ │ └── TestSourceDirMavenProjectStub.java
│ └── resources
│ └── unit
│ ├── aggregate-test
│ ├── aggregate-test-plugin-config.xml
│ ├── submodule1
│ │ ├── aggregate-test-plugin-config.xml
│ │ └── aggregate
│ │ │ └── test
│ │ │ └── submodule1
│ │ │ ├── Submodule1App.java
│ │ │ └── Submodule1AppSample.java
│ └── submodule2
│ │ ├── aggregate-test-plugin-config.xml
│ │ └── aggregate
│ │ └── test
│ │ └── submodule2
│ │ ├── Submodule2App.java
│ │ └── Submodule2AppSample.java
│ ├── default-configuration
│ ├── def
│ │ └── configuration
│ │ │ ├── App.java
│ │ │ └── AppSample.java
│ ├── default-configuration-plugin-config-4.xml
│ ├── default-configuration-plugin-config-6.xml
│ ├── default-configuration-plugin-config-7.xml
│ ├── default-configuration-plugin-config-8.xml
│ ├── default-configuration-plugin-config.xml
│ ├── exception-test-plugin-config.xml
│ └── javadoc-files
│ │ └── apidocs
│ │ ├── allclasses-frame.html
│ │ ├── allclasses-noframe.html
│ │ ├── constant-values.html
│ │ ├── def
│ │ └── configuration
│ │ │ ├── App.html
│ │ │ ├── AppSample.html
│ │ │ ├── class-use
│ │ │ ├── App.html
│ │ │ └── AppSample.html
│ │ │ ├── package-frame.html
│ │ │ ├── package-summary.html
│ │ │ ├── package-tree.html
│ │ │ └── package-use.html
│ │ ├── deprecated-list.html
│ │ ├── help-doc.html
│ │ ├── index-all.html
│ │ ├── index.html
│ │ ├── overview-tree.html
│ │ ├── package-list
│ │ ├── packages.html
│ │ ├── resources
│ │ └── inherit.gif
│ │ └── stylesheet.css
│ ├── exclude-configuration
│ ├── exclude-configuration-plugin-config.xml
│ └── exclude
│ │ └── configuration
│ │ ├── App.java
│ │ └── AppSample.java
│ ├── include-configuration
│ ├── include-configuration-plugin-config.xml
│ └── include
│ │ └── configuration
│ │ ├── App.java
│ │ └── AppSample.java
│ ├── nojavadocdir-test
│ ├── nojavadocdir-test-plugin-config.xml
│ └── nojavadocdir
│ │ └── test
│ │ ├── App.java
│ │ └── AppSample.java
│ ├── nojavadoclink-configuration
│ ├── nojavadoclink-configuration-plugin-config.xml
│ └── nojavadoclink
│ │ └── configuration
│ │ ├── App.java
│ │ ├── AppSample.java
│ │ └── sample
│ │ └── Sample.java
│ ├── pom-test
│ ├── pom-test-plugin-config.xml
│ └── src
│ │ ├── main
│ │ └── java
│ │ │ └── maven
│ │ │ └── App.java
│ │ └── test
│ │ └── java
│ │ └── maven
│ │ └── AppTest.java
│ └── testsourcedir-test
│ ├── src
│ ├── main
│ │ └── java
│ │ │ └── testsourcedir
│ │ │ └── test
│ │ │ ├── App.java
│ │ │ └── AppSample.java
│ └── test
│ │ └── java
│ │ └── testsourcedir
│ │ └── test
│ │ ├── AppSampleTest.java
│ │ └── AppTest.java
│ └── testsourcedir-test-plugin-config.xml
├── maven-jxr
├── pom.xml
└── src
│ ├── main
│ ├── java
│ │ └── org
│ │ │ └── apache
│ │ │ └── maven
│ │ │ └── jxr
│ │ │ ├── DirectoryIndexer.java
│ │ │ ├── JXR.java
│ │ │ ├── JavaCodeTransform.java
│ │ │ ├── JxrException.java
│ │ │ ├── ant
│ │ │ └── DirectoryScanner.java
│ │ │ ├── pacman
│ │ │ ├── BaseType.java
│ │ │ ├── ClassType.java
│ │ │ ├── FileManager.java
│ │ │ ├── ImportType.java
│ │ │ ├── JavaFile.java
│ │ │ ├── JavaFileImpl.java
│ │ │ ├── PackageManager.java
│ │ │ └── PackageType.java
│ │ │ └── util
│ │ │ ├── SimpleWordTokenizer.java
│ │ │ └── StringEntry.java
│ └── resources
│ │ └── templates
│ │ ├── allclasses-frame.vm
│ │ ├── index.vm
│ │ ├── jdk4
│ │ ├── allclasses-frame.vm
│ │ ├── index.vm
│ │ ├── overview-frame.vm
│ │ ├── overview-summary.vm
│ │ ├── package-frame.vm
│ │ └── package-summary.vm
│ │ ├── jdk7
│ │ ├── allclasses-frame.vm
│ │ ├── index.vm
│ │ ├── overview-frame.vm
│ │ ├── overview-summary.vm
│ │ ├── package-frame.vm
│ │ └── package-summary.vm
│ │ ├── jdk8
│ │ ├── allclasses-frame.vm
│ │ ├── index.vm
│ │ ├── overview-frame.vm
│ │ ├── overview-summary.vm
│ │ ├── package-frame.vm
│ │ └── package-summary.vm
│ │ ├── overview-frame.vm
│ │ ├── overview-summary.vm
│ │ ├── package-frame.vm
│ │ └── package-summary.vm
│ └── test
│ ├── java
│ └── org
│ │ └── apache
│ │ └── maven
│ │ └── jxr
│ │ ├── DirectoryIndexerTest.java
│ │ ├── IncludeExcludeTest.java
│ │ ├── JXR141Test.java
│ │ ├── JavaCodeTransformTest.java
│ │ ├── JxrBeanTest.java
│ │ ├── package-info.java
│ │ ├── pacman
│ │ └── JavaFileImplTest.java
│ │ └── util
│ │ └── SimpleWordTokenizerTest.java
│ └── resources
│ ├── ClassWithLink.java
│ ├── EmptyClass.java
│ ├── UnknownType.java
│ ├── exclude
│ └── ExcludedClass.java
│ ├── include
│ ├── IncludedClass.java
│ └── NotIncludedClass.java
│ ├── jxr135
│ └── org
│ │ └── apache
│ │ └── maven
│ │ └── jxr
│ │ └── pacman
│ │ └── ClassWithNested.java
│ ├── jxr141
│ └── Test141.java
│ ├── jxr170
│ └── org
│ │ └── apache
│ │ └── maven
│ │ └── jxr
│ │ └── pacman
│ │ └── ClassWithMultiLineString.java
│ ├── jxr175
│ └── org
│ │ └── apache
│ │ └── maven
│ │ └── jxr
│ │ └── pacman
│ │ └── Java14Record.java
│ └── jxr68
│ ├── CClass.java
│ ├── SomeClass.java
│ ├── pkga
│ ├── BClass.java
│ └── SomeClass.java
│ └── pkgb
│ ├── AClass.java
│ └── SomeClass.java
├── pom.xml
└── src
└── site
├── apt
├── examples
│ └── java.apt
└── index.apt
├── fml
└── faq.fml
├── resources
└── download.cgi
├── site.xml
└── xdoc
└── download.xml.vm
/.asf.yaml:
--------------------------------------------------------------------------------
1 | #
2 | # Licensed to the Apache Software Foundation (ASF) under one or more
3 | # contributor license agreements. See the NOTICE file distributed with
4 | # this work for additional information regarding copyright ownership.
5 | # The ASF licenses this file to You under the Apache License, Version 2.0
6 | # (the "License"); you may not use this file except in compliance with
7 | # the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | # see https://s.apache.org/asfyaml
18 | github:
19 | description: "Apache Maven JXR (Plugin)"
20 | homepage: https://maven.apache.org/jxr/
21 | labels:
22 | - java
23 | - build-management
24 | - maven-plugins
25 | - maven-jxr-plugin
26 | - maven
27 | enabled_merge_buttons:
28 | squash: true
29 | merge: false
30 | rebase: true
31 | autolink_jira:
32 | - JXR
33 | del_branch_on_merge: true
34 | features:
35 | issues: true
36 | notifications:
37 | commits: commits@maven.apache.org
38 | issues: issues@maven.apache.org
39 | pullrequests: issues@maven.apache.org
40 | jira_options: link label comment
41 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/BUG.yml:
--------------------------------------------------------------------------------
1 | #
2 | # Licensed to the Apache Software Foundation (ASF) under one or more
3 | # contributor license agreements. See the NOTICE file distributed with
4 | # this work for additional information regarding copyright ownership.
5 | # The ASF licenses this file to You under the Apache License, Version 2.0
6 | # (the "License"); you may not use this file except in compliance with
7 | # the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 |
18 | # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19 |
20 | name: Bug Report
21 | description: File a bug report
22 | labels: ["bug"]
23 |
24 | body:
25 | - type: markdown
26 | attributes:
27 | value: |
28 | Thanks for taking the time to fill out this bug report.
29 |
30 | Simple fixes in single PRs do not require issues.
31 |
32 | **Do you use the latest project version?**
33 |
34 | - type: input
35 | id: version
36 | attributes:
37 | label: Affected version
38 | validations:
39 | required: true
40 |
41 | - type: textarea
42 | id: message
43 | attributes:
44 | label: Bug description
45 | validations:
46 | required: true
47 |
48 |
49 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/FEATURE.yml:
--------------------------------------------------------------------------------
1 | #
2 | # Licensed to the Apache Software Foundation (ASF) under one or more
3 | # contributor license agreements. See the NOTICE file distributed with
4 | # this work for additional information regarding copyright ownership.
5 | # The ASF licenses this file to You under the Apache License, Version 2.0
6 | # (the "License"); you may not use this file except in compliance with
7 | # the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 |
18 | # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-githubs-form-schema
19 |
20 | name: Feature request
21 | description: File a proposal for new feature, improvement
22 | labels: ["enhancement"]
23 |
24 | body:
25 | - type: markdown
26 | attributes:
27 | value: |
28 | Thanks for taking the time to fill out this new feature, improvement proposal.
29 |
30 | - type: textarea
31 | id: message
32 | attributes:
33 | label: New feature, improvement proposal
34 | validations:
35 | required: true
36 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/config.yml:
--------------------------------------------------------------------------------
1 | #
2 | # Licensed to the Apache Software Foundation (ASF) under one or more
3 | # contributor license agreements. See the NOTICE file distributed with
4 | # this work for additional information regarding copyright ownership.
5 | # The ASF licenses this file to You under the Apache License, Version 2.0
6 | # (the "License"); you may not use this file except in compliance with
7 | # the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 |
18 | # https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/configuring-issue-templates-for-your-repository#configuring-the-template-chooser
19 |
20 | blank_issues_enabled: false
21 |
22 | contact_links:
23 |
24 | - name: Project Mailing Lists
25 | url: https://maven.apache.org/mailing-lists.html
26 | about: Please ask a question or discuss here
27 |
28 | - name: Old JIRA Issues
29 | url: https://issues.apache.org/jira/projects/JXR
30 | about: Please search old JIRA issues
31 |
--------------------------------------------------------------------------------
/.github/dependabot.yml:
--------------------------------------------------------------------------------
1 | #
2 | # Licensed to the Apache Software Foundation (ASF) under one or more
3 | # contributor license agreements. See the NOTICE file distributed with
4 | # this work for additional information regarding copyright ownership.
5 | # The ASF licenses this file to You under the Apache License, Version 2.0
6 | # (the "License"); you may not use this file except in compliance with
7 | # the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing, software
12 | # distributed under the License is distributed on an "AS IS" BASIS,
13 | # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
14 | # See the License for the specific language governing permissions and
15 | # limitations under the License.
16 | #
17 | version: 2
18 | updates:
19 | - package-ecosystem: "maven"
20 | directory: "/"
21 | schedule:
22 | interval: "daily"
23 | - package-ecosystem: "github-actions"
24 | directory: "/"
25 | schedule:
26 | interval: "daily"
27 |
28 |
--------------------------------------------------------------------------------
/.github/pull_request_template.md:
--------------------------------------------------------------------------------
1 | Following this checklist to help us incorporate your
2 | contribution quickly and easily:
3 |
4 | - [ ] Your pull request should address just one issue, without pulling in other changes.
5 | - [ ] Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
6 | - [ ] Each commit in the pull request should have a meaningful subject line and body.
7 | Note that commits might be squashed by a maintainer on merge.
8 | - [ ] Write unit tests that match behavioral changes, where the tests fail if the changes to the runtime are not applied.
9 | This may not always be possible but is a best-practice.
10 | - [ ] Run `mvn verify` to make sure basic checks pass.
11 | A more thorough check will be performed on your pull request automatically.
12 | - [ ] You have run the integration tests successfully (`mvn -Prun-its verify`).
13 |
14 | If your pull request is about ~20 lines of code you don't need to sign an
15 | [Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf) if you are unsure
16 | please ask on the developers list.
17 |
18 | To make clear that you license your contribution under
19 | the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
20 | you have to acknowledge this by using the following check-box.
21 |
22 | - [ ] I hereby declare this contribution to be licenced under the [Apache License Version 2.0, January 2004](http://www.apache.org/licenses/LICENSE-2.0)
23 | - [ ] In any other case, please file an [Apache Individual Contributor License Agreement](https://www.apache.org/licenses/icla.pdf).
24 |
--------------------------------------------------------------------------------
/.github/release-drafter.yml:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | _extends: maven-gh-actions-shared
19 |
--------------------------------------------------------------------------------
/.github/workflows/maven-verify.yml:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | name: Verify
19 |
20 | on:
21 | push:
22 | pull_request:
23 |
24 | jobs:
25 | build:
26 | name: Verify
27 | uses: apache/maven-gh-actions-shared/.github/workflows/maven-verify.yml@v4
28 |
--------------------------------------------------------------------------------
/.github/workflows/pr-automation.yml:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | name: PR Automation
19 | on:
20 | pull_request_target:
21 | types:
22 | - closed
23 |
24 | jobs:
25 | pr-automation:
26 | name: PR Automation
27 | uses: apache/maven-gh-actions-shared/.github/workflows/pr-automation.yml@v4
28 |
--------------------------------------------------------------------------------
/.github/workflows/release-drafter.yml:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | name: Release Drafter
19 | on:
20 | push:
21 | branches:
22 | - master
23 | workflow_dispatch:
24 |
25 | jobs:
26 | update_release_draft:
27 | uses: apache/maven-gh-actions-shared/.github/workflows/release-drafter.yml@v4
28 |
--------------------------------------------------------------------------------
/.github/workflows/stale.yml:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | name: Stale
19 |
20 | on:
21 | schedule:
22 | - cron: '38 3 * * *'
23 | issue_comment:
24 | types: [ 'created' ]
25 |
26 | jobs:
27 | stale:
28 | uses: 'apache/maven-gh-actions-shared/.github/workflows/stale.yml@v4'
29 |
--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | target/
2 | .project
3 | .classpath
4 | .factorypath
5 | .settings/
6 | .svn/
7 | bin/
8 | # Intellij
9 | *.ipr
10 | *.iml
11 | .idea
12 | out/
13 | .DS_Store
14 | /bootstrap
15 | /dependencies.xml
16 | .java-version
17 | .checkstyle
18 |
19 |
--------------------------------------------------------------------------------
/Jenkinsfile:
--------------------------------------------------------------------------------
1 | /**
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 |
20 | asfMavenTlpPlgnBuild()
21 |
--------------------------------------------------------------------------------
/deploySite.sh:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 |
3 | #
4 | # Licensed to the Apache Software Foundation (ASF) under one
5 | # or more contributor license agreements. See the NOTICE file
6 | # distributed with this work for additional information
7 | # regarding copyright ownership. The ASF licenses this file
8 | # to you under the Apache License, Version 2.0 (the
9 | # "License"); you may not use this file except in compliance
10 | # with the License. You may obtain a copy of the License at
11 | #
12 | # http://www.apache.org/licenses/LICENSE-2.0
13 | #
14 | # Unless required by applicable law or agreed to in writing,
15 | # software distributed under the License is distributed on an
16 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | # KIND, either express or implied. See the License for the
18 | # specific language governing permissions and limitations
19 | # under the License.
20 | #
21 |
22 | mvn -Preporting site site:stage
23 | mvn scm-publish:publish-scm
24 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-100_parameterlink/invoker.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | invoker.goals=jxr:jxr
19 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-100_parameterlink/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
20 |
21 | 4.0.0
22 | org.apache.maven.jxr.it
23 | jxr100
24 | 1.0.0-SNAPSHOT
25 |
26 |
27 |
28 |
29 |
30 | org.apache.maven.plugins
31 | maven-jxr-plugin
32 | @project.version@
33 |
34 | 1.4
35 |
36 |
37 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-100_parameterlink/src/main/java/com/mycompany/app/App.java:
--------------------------------------------------------------------------------
1 | package com.mycompany.app;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public interface App
23 | {
24 |
25 | }
26 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-100_parameterlink/src/main/java/com/mycompany/app/Foo.java:
--------------------------------------------------------------------------------
1 | package com.mycompany.app;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class Foo
23 | {
24 |
25 | public void withApp1(App app)
26 | {
27 | //no-op
28 | }
29 |
30 | public void withApp2 ( App app)
31 | {
32 | //no-op
33 | }
34 |
35 | public void withApp3 (App app)
36 | {
37 | //no-op
38 | }
39 |
40 | public void withApp4( App app)
41 | {
42 | //no-op
43 | }
44 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-100_parameterlink/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | File file = new File( basedir, 'target/reports/xref/com/mycompany/app/Foo.html' );
20 |
21 | assert file.exists()
22 |
23 | assert 4 == file.text.count( 'App' )
24 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-135_innerclasses/invoker.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | invoker.goals=jxr:jxr
19 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-135_innerclasses/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
20 |
21 | 4.0.0
22 | org.apache.maven.jxr.it
23 | jxr135
24 | 1.0.0-SNAPSHOT
25 |
26 |
27 |
28 |
29 |
30 | org.apache.maven.plugins
31 | maven-jxr-plugin
32 | @project.version@
33 |
34 | 1.4
35 |
36 |
37 |
38 |
39 |
40 |
41 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-135_innerclasses/src/main/java/com/mycompany/app/ClassWithNested.java:
--------------------------------------------------------------------------------
1 | package com.mycompany.app;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class ClassWithNested
23 | {
24 | public interface NestedInterface {}
25 | public static class NestedClassWithEnum {
26 | public enum NestedEnum { }
27 | public class NestedClass2 {
28 | }
29 | }
30 |
31 | public static class NestedClassWithEnum2 {
32 | public enum NestedEnum { }
33 | public class NestedClass2 {
34 | }
35 | }
36 | }
37 | class NotNested {}
38 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-143_nofork/invoker.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | invoker.goals=clean verify site
19 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-143_nofork/src/main/java/org/apache/maven/jxr/it/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-143_nofork/src/main/java/org/apache/maven/jxr/it/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-143_nofork/src/test/java/org/apache/maven/jxr/it/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/JXR-143_nofork/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | assert new File( basedir, 'target/site' ).exists()
20 |
21 | content = new File( basedir, 'target/site/project-reports.html' ).text
22 |
23 | assert content.contains( 'xref/index.html' )
24 | assert content.contains( 'xref-test/index.html' )
25 |
26 | assert new File( basedir, 'target/site/xref' ).exists()
27 | assert new File( basedir, 'target/site/xref/index.html' ).exists()
28 | assert new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).exists()
29 |
30 | assert new File( basedir, 'target/site/xref-test' ).exists()
31 | assert new File( basedir, 'target/site/xref-test/index.html' ).exists()
32 | assert new File( basedir, 'target/site/xref-test/org/apache/maven/jxr/it/AppTest.html' ).exists()
33 |
34 | content = new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).text
35 | assert content.contains( 'App2.html' )
36 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p1/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
23 | 4.0.0
24 |
25 | org.apache.maven.jxr.it
26 | agg-p1
27 |
28 |
29 | org.apache.maven.jxr.it
30 | aggregate
31 | 1-SNAPSHOT
32 |
33 |
34 | one aggregate module
35 | http://maven.apache.org
36 |
37 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p1/src/main/java/org/apache/maven/jxr/it/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p1/src/main/java/org/apache/maven/jxr/it/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p1/src/test/java/org/apache/maven/jxr/it/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p2/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
23 | 4.0.0
24 |
25 | org.apache.maven.jxr.it
26 | agg-p2
27 |
28 | org.apache.maven.jxr.it
29 | aggregate
30 | 1-SNAPSHOT
31 |
32 |
33 | agg-p2
34 | http://maven.apache.org
35 |
36 |
37 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p2/src/main/java/org/apache/maven/jxr/it2/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p2/src/main/java/org/apache/maven/jxr/it2/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/p2/src/test/java/org/apache/maven/jxr/it2/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/aggregate/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | assert new File( basedir, 'target/site' ).exists()
20 |
21 | content = new File( basedir, 'target/site/project-reports.html' ).text
22 |
23 | assert content.contains( 'xref/index.html' )
24 | assert content.contains( 'xref-test/index.html' )
25 |
26 | assert new File( basedir, 'target/site/xref' ).exists()
27 | assert new File( basedir, 'target/site/xref/index.html' ).exists()
28 | assert new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).exists()
29 | assert new File( basedir, 'target/site/xref/org/apache/maven/jxr/it2/App.html' ).exists()
30 |
31 | assert new File( basedir, 'target/site/xref-test' ).exists()
32 | assert new File( basedir, 'target/site/xref-test/index.html' ).exists()
33 | assert new File( basedir, 'target/site/xref-test/org/apache/maven/jxr/it/AppTest.html' ).exists()
34 | assert new File( basedir, 'target/site/xref-test/org/apache/maven/jxr/it2/AppTest.html' ).exists()
35 |
36 | content = new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).text
37 | assert content.contains( 'App2.html' )
38 |
39 | content = new File( basedir, 'target/site/xref/org/apache/maven/jxr/it2/App.html' ).text
40 | assert content.contains( 'App2.html' )
41 | content = new File( basedir, 'target/site/xref/index.html' ).text
42 | assert content.contains( 'this is a JXR report set' )
43 |
44 | assert new File( basedir, 'target/site/apidocs/index.html' ).exists()
45 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p1/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
23 | 4.0.0
24 |
25 | org.apache.maven.jxr.it
26 | mixed-p1
27 |
28 |
29 | org.apache.maven.jxr.it
30 | mixed-plugin-report
31 | 1-SNAPSHOT
32 |
33 |
34 | mixed-p1
35 | http://maven.apache.org
36 |
37 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p1/src/main/java/org/apache/maven/jxr/it/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p1/src/main/java/org/apache/maven/jxr/it/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p1/src/test/java/org/apache/maven/jxr/it/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p2/pom.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
23 | 4.0.0
24 |
25 | org.apache.maven.jxr.it
26 | mixed-p2
27 |
28 | org.apache.maven.jxr.it
29 | mixed-plugin-report
30 | 1-SNAPSHOT
31 |
32 |
33 | mixed-p2
34 | http://maven.apache.org
35 |
36 |
37 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p2/src/main/java/org/apache/maven/jxr/it2/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p2/src/main/java/org/apache/maven/jxr/it2/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/mixed-plugin-report/p2/src/test/java/org/apache/maven/jxr/it2/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/new-site-config/src/main/java/org/apache/maven/jxr/it/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/new-site-config/src/main/java/org/apache/maven/jxr/it/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/new-site-config/src/test/java/org/apache/maven/jxr/it/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/new-site-config/verify.groovy:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | assert new File( basedir, 'target/site' ).exists()
20 |
21 | content = new File( basedir, 'target/site/project-reports.html' ).text
22 |
23 | assert content.contains( 'xref/index.html' )
24 | assert content.contains( 'xref-test/index.html' )
25 |
26 | assert new File( basedir, 'target/site/xref' ).exists()
27 | assert new File( basedir, 'target/site/xref/index.html' ).exists()
28 | assert new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).exists()
29 |
30 | assert new File( basedir, 'target/site/xref-test' ).exists()
31 | assert new File( basedir, 'target/site/xref-test/index.html' ).exists()
32 | assert new File( basedir, 'target/site/xref-test/org/apache/maven/jxr/it/AppTest.html' ).exists()
33 |
34 | content = new File( basedir, 'target/site/xref/org/apache/maven/jxr/it/App.html' ).text
35 | assert content.contains( 'App2.html' )
36 | assert content.contains( '
' )
37 |
38 | assert new File( basedir, 'target/site/apidocs/index.html' ).exists()
39 | assert new File( basedir, 'target/site/testapidocs/index.html' ).exists();
40 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/settings.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
22 |
23 |
24 |
25 | it-repo
26 |
27 |
28 | local.central
29 | @localRepositoryUrl@
30 |
31 | true
32 |
33 |
34 | true
35 |
36 |
37 |
38 |
39 |
40 | local.central
41 | @localRepositoryUrl@
42 |
43 | true
44 |
45 |
46 | true
47 |
48 |
49 |
50 |
51 |
52 |
53 | it-repo
54 |
55 |
56 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/simple-project/src/main/java/org/apache/maven/jxr/it/App.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | extends App2
28 | {
29 | public static void main( String[] args )
30 | {
31 | System.out.println( "Hello World!" );
32 | }
33 | }
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/simple-project/src/main/java/org/apache/maven/jxr/it/App2.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App2
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/it/simple-project/src/test/java/org/apache/maven/jxr/it/AppTest.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr.it;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrReport.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr;
20 |
21 | import org.apache.maven.plugins.annotations.Execute;
22 | import org.apache.maven.plugins.annotations.LifecyclePhase;
23 | import org.apache.maven.plugins.annotations.Mojo;
24 |
25 | /**
26 | * Generates a combined JXR report in an aggregating project.
27 | *
28 | * @since 2.3
29 | */
30 | @Mojo(name = "aggregate", aggregator = true)
31 | @Execute(phase = LifecyclePhase.COMPILE)
32 | public class AggregatorJxrReport extends JxrReport {
33 |
34 | @Override
35 | protected boolean isAggregate() {
36 | return true;
37 | }
38 | }
39 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/AggregatorJxrTestReport.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr;
20 |
21 | import org.apache.maven.plugins.annotations.Execute;
22 | import org.apache.maven.plugins.annotations.LifecyclePhase;
23 | import org.apache.maven.plugins.annotations.Mojo;
24 |
25 | /**
26 | * Generates a combined JXR report for test code in an aggregating project.
27 | *
28 | * @since 2.3
29 | */
30 | @Mojo(name = "test-aggregate", aggregator = true)
31 | @Execute(phase = LifecyclePhase.TEST_COMPILE)
32 | public class AggregatorJxrTestReport extends JxrTestReport {
33 | @Override
34 | protected boolean isAggregate() {
35 | return true;
36 | }
37 | }
38 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrNoForkReport.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr;
20 |
21 | import org.apache.maven.plugins.annotations.Execute;
22 | import org.apache.maven.plugins.annotations.LifecyclePhase;
23 | import org.apache.maven.plugins.annotations.Mojo;
24 |
25 | /**
26 | * Creates an HTML-based, cross referenced version of Java source code
27 | * for a project without forking. Note that this goal does require generation of sources before
28 | * site generation, e.g. by invoking {@code }mvn clean deploy site}.
29 | *
30 | * @since 3.1.0
31 | */
32 | @Mojo(name = "jxr-no-fork")
33 | @Execute(phase = LifecyclePhase.NONE)
34 | public class JxrNoForkReport extends JxrReport {}
35 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/java/org/apache/maven/plugin/jxr/JxrTestNoForkReport.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr;
20 |
21 | import org.apache.maven.plugins.annotations.Execute;
22 | import org.apache.maven.plugins.annotations.LifecyclePhase;
23 | import org.apache.maven.plugins.annotations.Mojo;
24 |
25 | /**
26 | * Creates an HTML-based, cross referenced version of Java source code
27 | * for a project's test sources without forking. Note that this goal does require generation of test
28 | * sources before site generation, e.g. by invoking {@code }mvn clean deploy site}.
29 | *
30 | * @since 3.1.0
31 | */
32 | @Mojo(name = "test-jxr-no-fork")
33 | @Execute(phase = LifecyclePhase.NONE)
34 | public class JxrTestNoForkReport extends JxrTestReport {}
35 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk4/stylesheet.css:
--------------------------------------------------------------------------------
1 | /* Javadoc style sheet */
2 |
3 | /* Define colors, fonts and other style attributes here to override the defaults */
4 |
5 | /* Page background color */
6 | body { background-color: #FFFFFF }
7 |
8 | /* Headings */
9 | h1 { font-size: 145% }
10 |
11 | /* Table colors */
12 | .TableHeadingColor { background: #CCCCFF } /* Dark mauve */
13 | .TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
14 | .TableRowColor { background: #FFFFFF } /* White */
15 |
16 | /* Font used in left-hand frame lists */
17 | .FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
18 | .FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
19 | .FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
20 |
21 | /* Navigation bar fonts and colors */
22 | .NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */
23 | .NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */
24 | .NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
25 | .NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
26 |
27 | .NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
28 | .NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
29 |
30 | /* JXR style sheet */
31 | a.jxr_linenumber:link {
32 | color: #00f;
33 | }
34 |
35 | a.jxr_linenumber:visited {
36 | color: #00a;
37 | }
38 |
39 | a.jxr_linenumber:active, a.jxr_linenumber:hover {
40 | color: #f30 !important;
41 | }
42 |
43 | em.comment {
44 | color: #390;
45 | }
46 |
47 | .string {
48 | color: #009;
49 | }
50 |
51 | #overview {
52 | padding: 2px;
53 | font-size: 90%;
54 | font-family: Helvetica, Arial, sans-serif;
55 | }
56 |
57 | hr {
58 | color: #000;
59 | }
60 |
61 | .jxr_comment
62 | {
63 | color: #390;
64 | }
65 |
66 | .jxr_javadoccomment
67 | {
68 | color: #A00;
69 | }
70 |
71 | .jxr_string
72 | {
73 | color: #009;
74 | }
75 |
76 | .jxr_keyword
77 | {
78 | color: #000;
79 | }
80 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk6/stylesheet.css:
--------------------------------------------------------------------------------
1 | /* Javadoc style sheet */
2 |
3 | /* Define colors, fonts and other style attributes here to override the defaults */
4 |
5 | /* Page background color */
6 | body { background-color: #FFFFFF; color:#000000 }
7 |
8 | /* Headings */
9 | h1 { font-size: 145% }
10 |
11 | /* Table colors */
12 | .TableHeadingColor { background: #CCCCFF; color:#000000 } /* Dark mauve */
13 | .TableSubHeadingColor { background: #EEEEFF; color:#000000 } /* Light mauve */
14 | .TableRowColor { background: #FFFFFF; color:#000000 } /* White */
15 |
16 | /* Font used in left-hand frame lists */
17 | .FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
18 | .FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
19 | .FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif; color:#000000 }
20 |
21 | /* Navigation bar fonts and colors */
22 | .NavBarCell1 { background-color:#EEEEFF; color:#000000} /* Light mauve */
23 | .NavBarCell1Rev { background-color:#00008B; color:#FFFFFF} /* Dark Blue */
24 | .NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;color:#000000;}
25 | .NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;color:#FFFFFF;}
26 |
27 | .NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
28 | .NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF; color:#000000}
29 |
30 | /* JXR style sheet */
31 | a.jxr_linenumber:link {
32 | color: #00f;
33 | }
34 |
35 | a.jxr_linenumber:visited {
36 | color: #00a;
37 | }
38 |
39 | a.jxr_linenumber:active, a.jxr_linenumber:hover {
40 | color: #f30 !important;
41 | }
42 |
43 | em.comment {
44 | color: #390;
45 | }
46 |
47 | .string {
48 | color: #009;
49 | }
50 |
51 | #overview {
52 | padding: 2px;
53 | font-size: 90%;
54 | font-family: Helvetica, Arial, sans-serif;
55 | }
56 |
57 | hr {
58 | color: #000;
59 | }
60 |
61 | .jxr_comment
62 | {
63 | color: #390;
64 | }
65 |
66 | .jxr_javadoccomment
67 | {
68 | color: #A00;
69 | }
70 |
71 | .jxr_string
72 | {
73 | color: #009;
74 | }
75 |
76 | .jxr_keyword
77 | {
78 | color: #000;
79 | }
80 |
81 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk7/resources/background.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jdk7/resources/background.gif
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk7/resources/tab.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jdk7/resources/tab.gif
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk7/resources/titlebar.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jdk7/resources/titlebar.gif
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jdk7/resources/titlebar_end.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jdk7/resources/titlebar_end.gif
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | report.xref.main.name=Source Xref
19 | report.xref.main.description=HTML based, cross-reference version of Java source code.
20 | report.xref.test.name=Test Source Xref
21 | report.xref.test.description=HTML based, cross-reference version of Java test source code.
22 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report_de.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | report.xref.main.name=Quellcode-Xref
19 | report.xref.main.description=HTML-basierte, querverlinkte Version des Java-Quellcodes.
20 | report.xref.test.name=Testquellcode-Xref
21 | report.xref.test.description=HTML-basierte, querverlinkte Version des Java-Testquellcodes.
22 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report_el.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | report.xref.main.name=\u03a0\u03b7\u03b3\u03b1\u03af\u03bf\u03c2 \u03ba\u03ce\u03b4\u03b9\u03ba\u03b1\u03c2 Xref
19 | report.xref.main.description=\u0392\u03b1\u03c3\u03b9\u03c3\u03bc\u03ad\u03bd\u03b7 \u03c3\u03b5 HTML \u03ad\u03ba\u03b4\u03bf\u03c3\u03b7 \u03c0\u03b1\u03c1\u03b1\u03c0\u03bf\u03bc\u03c0\u03ae\u03c2 \u03c0\u03b7\u03b3\u03b1\u03af\u03bf\u03c5 \u03ba\u03ce\u03b4\u03b9\u03ba\u03b1 Java.
20 | report.xref.test.name=\u03a0\u03b7\u03b3\u03b1\u03af\u03bf\u03c2 \u03ba\u03ce\u03b4\u03b9\u03ba\u03b1\u03c2 Xref
21 | report.xref.test.description=\u0392\u03b1\u03c3\u03b9\u03c3\u03bc\u03ad\u03bd\u03b7 \u03c3\u03b5 HTML \u03ad\u03ba\u03b4\u03bf\u03c3\u03b7 \u03c0\u03b1\u03c1\u03b1\u03c0\u03bf\u03bc\u03c0\u03ae\u03c2 \u03c0\u03b7\u03b3\u03b1\u03af\u03bf\u03c5 \u03b4\u03bf\u03ba\u03b9\u03bc\u03b1\u03c3\u03c4\u03b9\u03ba\u03bf\u03cd \u03ba\u03ce\u03b4\u03b9\u03ba\u03b1 Java.
22 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report_en.properties:
--------------------------------------------------------------------------------
1 | # Licensed to the Apache Software Foundation (ASF) under one
2 | # or more contributor license agreements. See the NOTICE file
3 | # distributed with this work for additional information
4 | # regarding copyright ownership. The ASF licenses this file
5 | # to you under the Apache License, Version 2.0 (the
6 | # "License"); you may not use this file except in compliance
7 | # with the License. You may obtain a copy of the License at
8 | #
9 | # http://www.apache.org/licenses/LICENSE-2.0
10 | #
11 | # Unless required by applicable law or agreed to in writing,
12 | # software distributed under the License is distributed on an
13 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
14 | # KIND, either express or implied. See the License for the
15 | # specific language governing permissions and limitations
16 | # under the License.
17 |
18 | # NOTE:
19 | # This bundle is intentionally empty because English strings are provided by the base bundle via the parent chain. It
20 | # must be provided nevertheless such that a request for locale "en" will not errorneously pick up the bundle for the
21 | # JVM's default locale (which need not be "en"). See the method javadoc about
22 | # ResourceBundle.getBundle(String, Locale, ClassLoader)
23 | # for a full description of the lookup strategy.
24 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report_fr.properties:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jxr-report_fr.properties
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/jxr-report_sv.properties:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/main/resources/jxr-report_sv.properties
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/main/resources/stylesheet.css:
--------------------------------------------------------------------------------
1 | /* Javadoc style sheet */
2 | /* Define colors, fonts and other style attributes here to override the defaults */
3 | body {
4 | background-color: #fff;
5 | font-family: Arial, Helvetica, sans-serif;
6 | }
7 |
8 | a:link {
9 | color: #00f;
10 | }
11 | a:visited {
12 | color: #00a;
13 | }
14 |
15 | a:active, a:hover {
16 | color: #f30 !important;
17 | }
18 |
19 | ul, li {
20 | list-style-type:none;
21 | margin:0;
22 | padding:0;
23 | }
24 |
25 | table td {
26 | padding: 3px;
27 | border: 1px solid #000;
28 | }
29 | table {
30 | width:100%;
31 | border: 1px solid #000;
32 | border-collapse: collapse;
33 | }
34 |
35 | div.overview {
36 | background-color:#ddd;
37 | padding: 4px 4px 4px 0;
38 | }
39 | div.overview li, div.framenoframe li {
40 | display: inline;
41 | }
42 | div.framenoframe {
43 | text-align: center;
44 | font-size: x-small;
45 | }
46 | div.framenoframe li {
47 | margin: 0 3px 0 3px;
48 | }
49 | div.overview li {
50 | margin:3px 3px 0 3px;
51 | padding: 4px;
52 | }
53 | li.selected {
54 | background-color:#888;
55 | color: #fff;
56 | font-weight: bold;
57 | }
58 |
59 | table.summary {
60 | margin-bottom: 20px;
61 | }
62 | table.summary td, table.summary th {
63 | font-weight: bold;
64 | text-align: left;
65 | padding: 3px;
66 | }
67 | table.summary th {
68 | background-color:#036;
69 | color: #fff;
70 | }
71 | table.summary td {
72 | background-color:#eee;
73 | border: 1px solid black;
74 | }
75 |
76 | em {
77 | color: #A00;
78 | }
79 | em.comment {
80 | color: #390;
81 | }
82 | .string {
83 | color: #009;
84 | }
85 |
86 | #overview {
87 | padding:2px;
88 | }
89 |
90 | hr {
91 | height: 1px;
92 | color: #000;
93 | }
94 |
95 | /* JXR style sheet */
96 | .jxr_comment
97 | {
98 | color: #390;
99 | }
100 |
101 | .jxr_javadoccomment
102 | {
103 | color: #A00;
104 | }
105 |
106 | .jxr_string
107 | {
108 | color: #009;
109 | }
110 |
111 | .jxr_keyword
112 | {
113 | color: #000;
114 | }
115 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/site/apt/examples/linkjavadoc.apt.vm:
--------------------------------------------------------------------------------
1 | ------
2 | Linking JXR Files to Javadocs
3 | ------
4 | Maria Odea Ching
5 | ------
6 | 2010-01-20
7 | ------
8 |
9 | ~~ Licensed to the Apache Software Foundation (ASF) under one
10 | ~~ or more contributor license agreements. See the NOTICE file
11 | ~~ distributed with this work for additional information
12 | ~~ regarding copyright ownership. The ASF licenses this file
13 | ~~ to you under the Apache License, Version 2.0 (the
14 | ~~ "License"); you may not use this file except in compliance
15 | ~~ with the License. You may obtain a copy of the License at
16 | ~~
17 | ~~ http://www.apache.org/licenses/LICENSE-2.0
18 | ~~
19 | ~~ Unless required by applicable law or agreed to in writing,
20 | ~~ software distributed under the License is distributed on an
21 | ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
22 | ~~ KIND, either express or implied. See the License for the
23 | ~~ specific language governing permissions and limitations
24 | ~~ under the License.
25 |
26 |
27 | Linking JXR Files to Javadocs
28 |
29 | To link the generated JXR files to the Javadocs, you need to set the following JXR Plugin configuration in your <<>>:
30 |
31 | +-----+
32 |
33 | ...
34 |
35 |
36 | ...
37 |
38 | org.apache.maven.plugins
39 | maven-jxr-plugin
40 | ${project.version}
41 |
42 | ...
43 | true
44 | /path/to/javadocs
45 | ...
46 |
47 |
48 |
49 | ...
50 |
51 | ...
52 |
53 | +-----+
54 |
55 | The generated JXR pages will have a link named "View Javadoc" that will display the Javadoc of the class. In case there
56 | were no existing Javadocs in the specified Javadoc directory and no Javadocs will be generated (meaning no Javadoc Plugin
57 | configuration in the reporting section of the POM), the link will not be displayed even if the <<>> parameter
58 | is set to <<>>.
59 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/site/apt/usage.apt.vm:
--------------------------------------------------------------------------------
1 | ------
2 | Usage
3 | ------
4 | Fabrice Bellingard
5 |
6 | Maria Odea Ching
7 | ------
8 | 2010-04-27
9 | ------
10 |
11 | ~~ Licensed to the Apache Software Foundation (ASF) under one
12 | ~~ or more contributor license agreements. See the NOTICE file
13 | ~~ distributed with this work for additional information
14 | ~~ regarding copyright ownership. The ASF licenses this file
15 | ~~ to you under the Apache License, Version 2.0 (the
16 | ~~ "License"); you may not use this file except in compliance
17 | ~~ with the License. You may obtain a copy of the License at
18 | ~~
19 | ~~ http://www.apache.org/licenses/LICENSE-2.0
20 | ~~
21 | ~~ Unless required by applicable law or agreed to in writing,
22 | ~~ software distributed under the License is distributed on an
23 | ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
24 | ~~ KIND, either express or implied. See the License for the
25 | ~~ specific language governing permissions and limitations
26 | ~~ under the License.
27 |
28 |
29 | Usage
30 |
31 | The JXR Plugin generates a cross-reference of the project's sources. Below are the different goals and configurations
32 | for the plugin.
33 |
34 | * Generate JXR as Part of Project Reports
35 |
36 | To include the JXR report in the site generation process, insert the following in the <<<\>>> section of your
37 | <<>>:
38 |
39 | +-----+
40 |
41 | ...
42 |
43 | ...
44 |
45 |
46 |
47 |
48 | org.apache.maven.plugins
49 | maven-jxr-plugin
50 | ${project.version}
51 |
52 |
53 |
54 | ...
55 |
56 | +-----+
57 |
58 | The report will be generated when you execute:
59 |
60 | +-----+
61 | mvn site
62 | +-----+
63 |
64 | * Explicitly Generate JXR Files
65 |
66 | The JXR files for the project's main sources will be generated using this command:
67 |
68 | +-----+
69 | mvn jxr:jxr
70 | +-----+
71 |
72 | To generate JXR files for the project's test sources, execute this command:
73 |
74 | +-----+
75 | mvn jxr:test-jxr
76 | +-----+
77 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/site/fml/faq.fml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
22 |
23 |
27 |
28 |
29 | Is there a way to run JXR with an Ant build?
30 |
31 |
32 | There isn't currently an Ant task, but it is a separate library so it
33 | wouldn't be hard to write one if someone was willing to contribute it.
34 |
41 |
42 |
43 |
44 |
45 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/site/resources/example/xref/stylesheet.css:
--------------------------------------------------------------------------------
1 | /* Javadoc style sheet */
2 | /* Define colors, fonts and other style attributes here to override the defaults */
3 | body {
4 | background-color: #fff;
5 | font-family: Arial, Helvetica, sans-serif;
6 | }
7 |
8 | a:link {
9 | color: #00f;
10 | }
11 | a:visited {
12 | color: #00a;
13 | }
14 |
15 | a:active, a:hover {
16 | color: #f30 !important;
17 | }
18 |
19 | ul, li {
20 | list-style-type:none ;
21 | margin:0;
22 | padding:0;
23 | }
24 |
25 | table td{
26 | padding: 3px;
27 | border: 1px solid #000;
28 | }
29 | table{
30 | width:100%;
31 | border: 1px solid #000;
32 | border-collapse: collapse;
33 | }
34 |
35 | div.overview {
36 | background-color:#ddd;
37 | padding: 4px 4px 4px 0;
38 | }
39 | div.overview li, div.framenoframe li {
40 | display: inline;
41 | }
42 | div.framenoframe {
43 | text-align: center;
44 | font-size: x-small;
45 | }
46 | div.framenoframe li {
47 | margin: 0 3px 0 3px;
48 | }
49 | div.overview li {
50 | margin:3px 3px 0 3px;
51 | padding: 4px;
52 | }
53 | li.selected {
54 | background-color:#888;
55 | color: #fff;
56 | font-weight: bold;
57 | }
58 |
59 | table.summary {
60 | margin-bottom: 20px;
61 | }
62 | table.summary td, table.summary th {
63 | font-weight: bold;
64 | text-align: left;
65 | padding: 3px;
66 | }
67 | table.summary th{
68 | background-color:#036;
69 | color: #fff;
70 | }
71 | table.summary td{
72 | background-color:#eee;
73 | border: 1px solid black;
74 | }
75 |
76 | em {
77 | color: #A00;
78 | }
79 | em.comment {
80 | color: #390;
81 | }
82 | .string {
83 | color: #009;
84 | }
85 | div#footer {
86 | text-align:center;
87 | }
88 | #overview {
89 | padding:2px;
90 | }
91 |
92 |
93 | hr {
94 | height: 1px;
95 | color: #000;
96 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/site/site.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
22 |
26 |
27 |
36 |
43 |
44 |
45 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/stubs/AggregateSubmodule1MavenProjectStub.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr.stubs;
20 |
21 | import java.util.ArrayList;
22 | import java.util.List;
23 |
24 | import org.apache.maven.artifact.Artifact;
25 | import org.apache.maven.plugin.testing.stubs.MavenProjectStub;
26 |
27 | /**
28 | * @author Maria Odea Ching
29 | */
30 | public class AggregateSubmodule1MavenProjectStub extends MavenProjectStub {
31 |
32 | public AggregateSubmodule1MavenProjectStub() {
33 | setArtifactId("aggregate-test-submodule1");
34 | setGroupId("aggregate.test");
35 | setVersion("1.0-SNAPSHOT");
36 | setPackaging("jar");
37 | setInceptionYear("2006");
38 |
39 | String basedir = getBasedir().getAbsolutePath();
40 | List compileSourceRoots = new ArrayList<>();
41 | compileSourceRoots.add(
42 | basedir + "/src/test/resources/unit/aggregate-test/submodule1/aggregate/test/submodule1");
43 | setCompileSourceRoots(compileSourceRoots);
44 |
45 | Artifact artifact = new JxrPluginArtifactStub(getGroupId(), getArtifactId(), getVersion(), getPackaging());
46 | artifact.setArtifactHandler(new DefaultArtifactHandlerStub());
47 | setArtifact(artifact);
48 | }
49 | }
50 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/java/org/apache/maven/plugin/jxr/stubs/DefaultArtifactHandlerStub.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.plugin.jxr.stubs;
20 |
21 | import org.apache.maven.artifact.handler.DefaultArtifactHandler;
22 |
23 | /**
24 | * @author Maria Odea Ching
25 | */
26 | public class DefaultArtifactHandlerStub extends DefaultArtifactHandler {
27 | private String language;
28 |
29 | public String getLanguage() {
30 | if (language == null) {
31 | language = "java";
32 | }
33 |
34 | return language;
35 | }
36 |
37 | public void setLanguage(String language) {
38 | this.language = language;
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule1/aggregate-test-plugin-config.xml:
--------------------------------------------------------------------------------
1 |
19 |
20 |
21 | 4.0.0
22 |
23 | aggregate.test
24 | aggregate-test
25 | 1.0-SNAPSHOT
26 |
27 | aggregate-test-submodule1
28 | jar
29 | 1.0-SNAPSHOT
30 | 2006
31 | Maven Jxr Plugin Aggregate Test Submodule1
32 | http://maven.apache.org
33 |
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule1/aggregate/test/submodule1/Submodule1App.java:
--------------------------------------------------------------------------------
1 | package aggregate.test.submodule1;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class Submodule1App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule1/aggregate/test/submodule1/Submodule1AppSample.java:
--------------------------------------------------------------------------------
1 | package aggregate.test.submodule1;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class Submodule1AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule2/aggregate-test-plugin-config.xml:
--------------------------------------------------------------------------------
1 |
19 |
20 |
21 | 4.0.0
22 |
23 | aggregate.test
24 | aggregate-test
25 | 1.0-SNAPSHOT
26 |
27 | aggregate-test-submodule2
28 | jar
29 | 1.0-SNAPSHOT
30 | 2006
31 | Maven Jxr Plugin Aggregate Test Submodule2
32 | http://maven.apache.org
33 |
34 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule2/aggregate/test/submodule2/Submodule2App.java:
--------------------------------------------------------------------------------
1 | package aggregate.test.submodule2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class Submodule2App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/aggregate-test/submodule2/aggregate/test/submodule2/Submodule2AppSample.java:
--------------------------------------------------------------------------------
1 | package aggregate.test.submodule2;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class Submodule2AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/default-configuration/def/configuration/App.java:
--------------------------------------------------------------------------------
1 | package def.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/default-configuration/def/configuration/AppSample.java:
--------------------------------------------------------------------------------
1 | package def.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/default-configuration/javadoc-files/apidocs/allclasses-frame.html:
--------------------------------------------------------------------------------
1 |
2 |
3 |
4 |
5 |
6 |
7 |
8 | All Classes (Maven Javadoc Plugin Default configuration Test 1.0-SNAPSHOT API)
9 |
10 |
11 |
12 |
13 |
14 |
15 |
16 |
17 |
18 |
19 | All Classes
20 |
21 |
22 |
19 | This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client.
20 |
21 | Link toNon-frame version.
22 |
36 |
37 |
38 |
39 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/default-configuration/javadoc-files/apidocs/resources/inherit.gif:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr-plugin/src/test/resources/unit/default-configuration/javadoc-files/apidocs/resources/inherit.gif
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/default-configuration/javadoc-files/apidocs/stylesheet.css:
--------------------------------------------------------------------------------
1 | /* Javadoc style sheet */
2 |
3 | /* Define colors, fonts and other style attributes here to override the defaults */
4 |
5 | /* Page background color */
6 | body { background-color: #FFFFFF }
7 |
8 | /* Headings */
9 | h1 { font-size: 145% }
10 |
11 | /* Table colors */
12 | .TableHeadingColor { background: #CCCCFF } /* Dark mauve */
13 | .TableSubHeadingColor { background: #EEEEFF } /* Light mauve */
14 | .TableRowColor { background: #FFFFFF } /* White */
15 |
16 | /* Font used in left-hand frame lists */
17 | .FrameTitleFont { font-size: 100%; font-family: Helvetica, Arial, sans-serif }
18 | .FrameHeadingFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
19 | .FrameItemFont { font-size: 90%; font-family: Helvetica, Arial, sans-serif }
20 |
21 | /* Navigation bar fonts and colors */
22 | .NavBarCell1 { background-color:#EEEEFF;} /* Light mauve */
23 | .NavBarCell1Rev { background-color:#00008B;} /* Dark Blue */
24 | .NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
25 | .NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
26 |
27 | .NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
28 | .NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
29 |
30 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude/configuration/App.java:
--------------------------------------------------------------------------------
1 | package exclude.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Dennis Lundberg
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/exclude-configuration/exclude/configuration/AppSample.java:
--------------------------------------------------------------------------------
1 | package exclude.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Dennis Lundberg
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/include-configuration/include/configuration/App.java:
--------------------------------------------------------------------------------
1 | package include.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Dennis Lundberg
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/include-configuration/include/configuration/AppSample.java:
--------------------------------------------------------------------------------
1 | package include.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Dennis Lundberg
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir/test/App.java:
--------------------------------------------------------------------------------
1 | package nojavadocdir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/nojavadocdir-test/nojavadocdir/test/AppSample.java:
--------------------------------------------------------------------------------
1 | package nojavadocdir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink/configuration/App.java:
--------------------------------------------------------------------------------
1 | package nojavadoclink.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink/configuration/AppSample.java:
--------------------------------------------------------------------------------
1 | package nojavadoclink.configuration;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/nojavadoclink-configuration/nojavadoclink/configuration/sample/Sample.java:
--------------------------------------------------------------------------------
1 | package nojavadoclink.configuration.sample;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class Sample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/pom-test/pom-test-plugin-config.xml:
--------------------------------------------------------------------------------
1 |
19 |
20 |
22 | 4.0.0
23 | test.jxr.pom
24 | pom
25 | 1.0-SNAPSHOT
26 | pom
27 | project1
28 |
29 |
30 | junit
31 | junit
32 | 3.8.1
33 | test
34 |
35 |
36 |
37 |
38 |
39 | org.apache.maven.plugins
40 | maven-jxr-plugin
41 |
42 |
43 | ${basedir}/target/test/unit/pom-test/target/site/
44 |
45 |
46 |
47 |
48 |
49 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/pom-test/src/main/java/maven/App.java:
--------------------------------------------------------------------------------
1 | package maven;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Hello world!
24 | *
25 | */
26 | public class App
27 | {
28 | public static void main( String[] args )
29 | {
30 | System.out.println( "Hello World!" );
31 | }
32 | }
33 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/pom-test/src/test/java/maven/AppTest.java:
--------------------------------------------------------------------------------
1 | package maven;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import junit.framework.Test;
23 | import junit.framework.TestCase;
24 | import junit.framework.TestSuite;
25 |
26 | /**
27 | * Unit test for simple App.
28 | */
29 | public class AppTest
30 | extends TestCase
31 | {
32 | /**
33 | * Create the test case
34 | *
35 | * @param testName name of the test case
36 | */
37 | public AppTest( String testName )
38 | {
39 | super( testName );
40 | }
41 |
42 | /**
43 | * @return the suite of tests being tested
44 | */
45 | public static Test suite()
46 | {
47 | return new TestSuite( AppTest.class );
48 | }
49 |
50 | /**
51 | * Rigourous Test :-)
52 | */
53 | public void testApp()
54 | {
55 | assertTrue( true );
56 | }
57 | }
58 |
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/src/main/java/testsourcedir/test/App.java:
--------------------------------------------------------------------------------
1 | package testsourcedir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class used for testing
24 | *
25 | * @author Maria Odea Ching
26 | */
27 | public class App
28 | {
29 | /**
30 | * The main method
31 | *
32 | * @param args an array of strings that contains the arguments
33 | */
34 | public static void main( String[] args )
35 | {
36 | System.out.println( "Sample Application." );
37 | }
38 |
39 | /**
40 | * Sample method
41 | *
42 | * @param str the value to be displayed
43 | */
44 | protected void sampleMethod( String str )
45 | {
46 | System.out.println( str );
47 | }
48 |
49 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/src/main/java/testsourcedir/test/AppSample.java:
--------------------------------------------------------------------------------
1 | package testsourcedir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * @author Maria Odea Ching
24 | */
25 | public class AppSample
26 | {
27 |
28 | /**
29 | * The main method
30 | *
31 | * @param args an array of strings that contains the arguments
32 | */
33 | public static void main( String[] args )
34 | {
35 | System.out.println( "Another Sample Application" );
36 | }
37 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/src/test/java/testsourcedir/test/AppSampleTest.java:
--------------------------------------------------------------------------------
1 | package testsourcedir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import org.codehaus.plexus.PlexusTestCase;
23 |
24 | /**
25 | * @author Maria Odea Ching
26 | */
27 | public class AppSampleTest
28 | extends PlexusTestCase
29 | {
30 | /**
31 | *
32 | * @throws Exception
33 | */
34 | protected void setUp()
35 | throws Exception
36 | {
37 | super.setUp();
38 | }
39 |
40 | /**
41 | * Method to test App
42 | *
43 | * @throws Exception
44 | */
45 | public void testApp()
46 | throws Exception
47 | {
48 | System.out.println( "TEST" );
49 | }
50 |
51 | /**
52 | *
53 | * @throws Exception
54 | */
55 | protected void tearDown()
56 | throws Exception
57 | {
58 |
59 | }
60 |
61 | }
--------------------------------------------------------------------------------
/maven-jxr-plugin/src/test/resources/unit/testsourcedir-test/src/test/java/testsourcedir/test/AppTest.java:
--------------------------------------------------------------------------------
1 | package testsourcedir.test;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | import org.codehaus.plexus.PlexusTestCase;
23 |
24 | /**
25 | * This is a sample test class used for testing
26 | *
27 | * @author Maria Odea Ching
28 | */
29 | public class AppTest
30 | extends PlexusTestCase
31 | {
32 | /**
33 | *
34 | * @throws Exception
35 | */
36 | protected void setUp()
37 | throws Exception
38 | {
39 | super.setUp();
40 | }
41 |
42 | /**
43 | * Method to test App
44 | *
45 | * @throws Exception
46 | */
47 | public void testApp()
48 | throws Exception
49 | {
50 | System.out.println( "TEST" );
51 | }
52 |
53 | /**
54 | *
55 | * @throws Exception
56 | */
57 | protected void tearDown()
58 | throws Exception
59 | {
60 |
61 | }
62 |
63 | }
--------------------------------------------------------------------------------
/maven-jxr/src/main/java/org/apache/maven/jxr/JxrException.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.jxr;
20 |
21 | /**
22 | * Exception occurring in JXR.
23 | *
24 | * @author Brett Porter
25 | */
26 | public class JxrException extends Exception {
27 | public JxrException(String message, Exception e) {
28 | super(message, e);
29 | }
30 | }
31 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/java/org/apache/maven/jxr/ant/DirectoryScanner.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.jxr.ant;
20 |
21 | import java.io.File;
22 |
23 | /**
24 | * Workaround to ignore package-info.java files.
25 | *
26 | * @author Carlos Sanchez
27 | */
28 | public class DirectoryScanner extends org.codehaus.plexus.util.DirectoryScanner {
29 |
30 | @Override
31 | public void addDefaultExcludes() {
32 | super.addDefaultExcludes();
33 | int excludesLength = excludes == null ? 0 : excludes.length;
34 | String[] newExcludes;
35 | newExcludes = new String[excludesLength + 1];
36 | if (excludesLength > 0) {
37 | System.arraycopy(excludes, 0, newExcludes, 0, excludesLength);
38 | }
39 | newExcludes[excludesLength] = "**" + File.separatorChar + "package-info.java";
40 | excludes = newExcludes;
41 | }
42 | }
43 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/java/org/apache/maven/jxr/pacman/BaseType.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.jxr.pacman;
20 |
21 | import java.util.Objects;
22 |
23 | /**
24 | * put your documentation comment here
25 | *
26 | * @author jvanzyl
27 | */
28 | public abstract class BaseType {
29 | private final String name;
30 |
31 | /**
32 | * Constructs type and set its name.
33 | *
34 | * @param name type name
35 | */
36 | public BaseType(String name) {
37 | this.name = Objects.requireNonNull(name);
38 | }
39 |
40 | /**
41 | * Gets the name for this type.
42 | *
43 | * @return The name value
44 | */
45 | public String getName() {
46 | return this.name;
47 | }
48 |
49 | @Override
50 | public String toString() {
51 | return getClass().getSimpleName() + "[name=" + name + "]";
52 | }
53 | }
54 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/java/org/apache/maven/jxr/util/StringEntry.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.jxr.util;
20 |
21 | /**
22 | * A StringEntry represents a value found by the tokenizer. The index is where
23 | * this StringEntry was found in the source string.
24 | */
25 | public final class StringEntry {
26 | private final String value;
27 |
28 | private final int index;
29 |
30 | /**
31 | * Constructor.
32 | *
33 | * @param value value
34 | * @param index index
35 | */
36 | public StringEntry(String value, int index) {
37 | this.value = value;
38 | this.index = index;
39 | }
40 |
41 | /**
42 | * Gets the index attribute of the StringEntry object.
43 | *
44 | * @return index
45 | */
46 | public int getIndex() {
47 | return this.index;
48 | }
49 |
50 | @Override
51 | public String toString() {
52 | return this.value;
53 | }
54 | }
55 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/allclasses-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 | All Classes
26 |
27 |
28 |
29 |
30 |
All Classes
31 |
32 |
33 | #foreach ($classInfo in $info.allClasses.values())
34 |
39 |
40 |
41 |
42 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/index.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
36 |
40 |
41 |
42 |
43 |
44 |
45 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk4/allclasses-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | All Classes
27 |
28 |
29 |
30 | All Classes
31 |
32 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk4/index.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle
27 |
28 |
29 |
30 |
31 |
32 |
33 |
34 |
35 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk4/package-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle Package $pkgInfo.name
27 |
28 |
29 |
30 |
31 | $pkgInfo.name
32 |
33 |
34 |
47 |
48 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk7/allclasses-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | All Classes
27 |
28 |
29 |
30 |
All Classes
31 |
32 |
33 | #foreach ($classInfo in $info.allClasses.values())
34 |
38 |
39 |
40 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk7/overview-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle
27 |
28 |
29 |
30 |
43 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk7/package-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle Package $pkgInfo.name
27 |
28 |
29 |
30 |
41 |
42 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk8/allclasses-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | All Classes
27 |
28 |
29 |
30 |
All Classes
31 |
32 |
33 | #foreach ($classInfo in $info.allClasses.values())
34 |
38 |
39 |
40 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk8/overview-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle
27 |
28 |
29 |
30 |
43 |
44 |
45 |
46 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/jdk8/package-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 |
26 | $windowTitle Package $pkgInfo.name
27 |
28 |
29 |
30 |
41 |
42 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/overview-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 | $windowTitle
26 |
27 |
28 |
29 |
30 |
43 |
44 |
45 |
46 |
47 |
--------------------------------------------------------------------------------
/maven-jxr/src/main/resources/templates/package-frame.vm:
--------------------------------------------------------------------------------
1 | #*
2 |
3 | Licensed to the Apache Software Foundation (ASF) under one
4 | or more contributor license agreements. See the NOTICE file
5 | distributed with this work for additional information
6 | regarding copyright ownership. The ASF licenses this file
7 | to you under the Apache License, Version 2.0 (the
8 | "License"); you may not use this file except in compliance
9 | with the License. You may obtain a copy of the License at
10 |
11 | http://www.apache.org/licenses/LICENSE-2.0
12 |
13 | Unless required by applicable law or agreed to in writing,
14 | software distributed under the License is distributed on an
15 | "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | KIND, either express or implied. See the License for the
17 | specific language governing permissions and limitations
18 | under the License.
19 |
20 | *#
21 |
22 |
23 |
24 |
25 | $windowTitle Package $pkgInfo.name
26 |
27 |
28 |
29 |
30 |
43 |
44 |
45 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/java/org/apache/maven/jxr/JxrBeanTest.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 | package org.apache.maven.jxr;
20 |
21 | import java.nio.file.Paths;
22 | import java.util.Collections;
23 |
24 | import org.apache.maven.jxr.pacman.FileManager;
25 | import org.apache.maven.jxr.pacman.PackageManager;
26 | import org.junit.jupiter.api.BeforeEach;
27 | import org.junit.jupiter.api.Test;
28 |
29 | class JxrBeanTest {
30 | private JXR jxrBean;
31 |
32 | @BeforeEach
33 | void setUp() {
34 | FileManager fileManager = new FileManager();
35 | PackageManager packageManager = new PackageManager(fileManager);
36 | JavaCodeTransform codeTransform = new JavaCodeTransform(packageManager, fileManager);
37 | jxrBean = new JXR(packageManager, codeTransform);
38 | jxrBean.setDest(Paths.get("target"));
39 | jxrBean.setInputEncoding("ISO-8859-1");
40 | jxrBean.setOutputEncoding("ISO-8859-1");
41 | jxrBean.setJavadocLinkDir(Paths.get("."));
42 | }
43 |
44 | @Test
45 | void xref() throws Exception {
46 | jxrBean.xref(Collections.singletonList("src/test/java"), "templates/jdk4", "title", "title", "copyright");
47 | }
48 | }
49 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/java/org/apache/maven/jxr/package-info.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/ClassWithLink.java:
--------------------------------------------------------------------------------
1 | /*
2 | * Licensed to the Apache Software Foundation (ASF) under one
3 | * or more contributor license agreements. See the NOTICE file
4 | * distributed with this work for additional information
5 | * regarding copyright ownership. The ASF licenses this file
6 | * to you under the Apache License, Version 2.0 (the
7 | * "License"); you may not use this file except in compliance
8 | * with the License. You may obtain a copy of the License at
9 | *
10 | * http://www.apache.org/licenses/LICENSE-2.0
11 | *
12 | * Unless required by applicable law or agreed to in writing,
13 | * software distributed under the License is distributed on an
14 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 | * KIND, either express or implied. See the License for the
16 | * specific language governing permissions and limitations
17 | * under the License.
18 | */
19 |
20 | /**
21 | * This is a sample class used for testing
22 | *
23 | * https://www.apache.org/licenses/LICENSE-2.0
24 | *
25 | * @author Jesper Udby
26 | */
27 | public class ClassWithLink
28 | {
29 | }
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/EmptyClass.java:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/apache/maven-jxr/bc2f0f215b02d0d1e67b6829fbaed5973c5f57fc/maven-jxr/src/test/resources/EmptyClass.java
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/UnknownType.java:
--------------------------------------------------------------------------------
1 | package example;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * This is a sample class with unknown type.
24 | */
25 | public unknown UnknownType
26 | {
27 | }
28 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/exclude/ExcludedClass.java:
--------------------------------------------------------------------------------
1 | package exclude;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * An excluded class.
24 | */
25 | public class ExcludedClass
26 | {
27 | }
28 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/include/IncludedClass.java:
--------------------------------------------------------------------------------
1 | package include;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * An included class.
24 | */
25 | public class IncludedClass
26 | {
27 | }
28 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/include/NotIncludedClass.java:
--------------------------------------------------------------------------------
1 | package include;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * A class that is not included.
24 | */
25 | public class NotIncludedClass
26 | {
27 | }
28 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr135/org/apache/maven/jxr/pacman/ClassWithNested.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Class part of the test for JXR-135 illustrating the use of nested classes, interfaces and enums
24 | */
25 | public class ClassWithNested
26 | {
27 | public interface NestedInterface {}
28 | public static class NestedClassWithEnum {
29 | public enum NestedEnum { }
30 | public class NestedClass2 {
31 | }
32 | }
33 |
34 | public static class NestedClassWithEnum2 {
35 | public enum NestedEnum { }
36 | public class NestedClass2 {
37 | }
38 | }
39 | }
40 | class NotNested {}
41 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr141/Test141.java:
--------------------------------------------------------------------------------
1 |
2 | /*
3 | * Licensed to the Apache Software Foundation (ASF) under one
4 | * or more contributor license agreements. See the NOTICE file
5 | * distributed with this work for additional information
6 | * regarding copyright ownership. The ASF licenses this file
7 | * to you under the Apache License, Version 2.0 (the
8 | * "License"); you may not use this file except in compliance
9 | * with the License. You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing,
14 | * software distributed under the License is distributed on an
15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | * KIND, either express or implied. See the License for the
17 | * specific language governing permissions and limitations
18 | * under the License.
19 | */
20 |
21 | /**
22 | * Simple test JAVA source that illustrates a line with more
23 | * than one "token" to replace
24 | */
25 | public class Test141
26 | {
27 | public static final Test141 instance = new Test141();
28 | }
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr170/org/apache/maven/jxr/pacman/ClassWithMultiLineString.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Test Java source of the test for JXR-170.
24 | *
25 | * @author Markus Spann
26 | */
27 | public class ClassWithMultiLineString {
28 |
29 | private final String str;
30 |
31 | public ClassWithMultiLineString(String _str) {
32 | str = _str;
33 | }
34 |
35 | public static void main(String[] args) {
36 | new ClassWithMultiLineString("""
37 | import java.util.List;
38 | """);
39 | }
40 | }
41 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr175/org/apache/maven/jxr/pacman/Java14Record.java:
--------------------------------------------------------------------------------
1 | package org.apache.maven.jxr;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | /**
23 | * Test Java source of the test for JXR-175.
24 | *
25 | * @author Markus Spann
26 | */
27 | public record Java14Record(
28 | String aString,
29 | int anInt) {
30 | }
31 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/CClass.java:
--------------------------------------------------------------------------------
1 |
2 | /*
3 | * Licensed to the Apache Software Foundation (ASF) under one
4 | * or more contributor license agreements. See the NOTICE file
5 | * distributed with this work for additional information
6 | * regarding copyright ownership. The ASF licenses this file
7 | * to you under the Apache License, Version 2.0 (the
8 | * "License"); you may not use this file except in compliance
9 | * with the License. You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing,
14 | * software distributed under the License is distributed on an
15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | * KIND, either express or implied. See the License for the
17 | * specific language governing permissions and limitations
18 | * under the License.
19 | */
20 |
21 | public class CClass {}
22 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/SomeClass.java:
--------------------------------------------------------------------------------
1 |
2 | /*
3 | * Licensed to the Apache Software Foundation (ASF) under one
4 | * or more contributor license agreements. See the NOTICE file
5 | * distributed with this work for additional information
6 | * regarding copyright ownership. The ASF licenses this file
7 | * to you under the Apache License, Version 2.0 (the
8 | * "License"); you may not use this file except in compliance
9 | * with the License. You may obtain a copy of the License at
10 | *
11 | * http://www.apache.org/licenses/LICENSE-2.0
12 | *
13 | * Unless required by applicable law or agreed to in writing,
14 | * software distributed under the License is distributed on an
15 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | * KIND, either express or implied. See the License for the
17 | * specific language governing permissions and limitations
18 | * under the License.
19 | */
20 |
21 | public class SomeClass {}
22 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/pkga/BClass.java:
--------------------------------------------------------------------------------
1 | package pkga;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class BClass {}
23 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/pkga/SomeClass.java:
--------------------------------------------------------------------------------
1 | package pkga;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class SomeClass {}
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/pkgb/AClass.java:
--------------------------------------------------------------------------------
1 | package pkgb;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class AClass {}
23 |
--------------------------------------------------------------------------------
/maven-jxr/src/test/resources/jxr68/pkgb/SomeClass.java:
--------------------------------------------------------------------------------
1 | package pkgb;
2 |
3 | /*
4 | * Licensed to the Apache Software Foundation (ASF) under one
5 | * or more contributor license agreements. See the NOTICE file
6 | * distributed with this work for additional information
7 | * regarding copyright ownership. The ASF licenses this file
8 | * to you under the Apache License, Version 2.0 (the
9 | * "License"); you may not use this file except in compliance
10 | * with the License. You may obtain a copy of the License at
11 | *
12 | * http://www.apache.org/licenses/LICENSE-2.0
13 | *
14 | * Unless required by applicable law or agreed to in writing,
15 | * software distributed under the License is distributed on an
16 | * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17 | * KIND, either express or implied. See the License for the
18 | * specific language governing permissions and limitations
19 | * under the License.
20 | */
21 |
22 | public class SomeClass {}
--------------------------------------------------------------------------------
/src/site/apt/index.apt:
--------------------------------------------------------------------------------
1 | ------
2 | Introduction
3 | ------
4 | Jason van Zyl
5 | Vincent Siveton
6 | ------
7 | 2010-01-20
8 | ------
9 |
10 | ~~ Licensed to the Apache Software Foundation (ASF) under one
11 | ~~ or more contributor license agreements. See the NOTICE file
12 | ~~ distributed with this work for additional information
13 | ~~ regarding copyright ownership. The ASF licenses this file
14 | ~~ to you under the Apache License, Version 2.0 (the
15 | ~~ "License"); you may not use this file except in compliance
16 | ~~ with the License. You may obtain a copy of the License at
17 | ~~
18 | ~~ http://www.apache.org/licenses/LICENSE-2.0
19 | ~~
20 | ~~ Unless required by applicable law or agreed to in writing,
21 | ~~ software distributed under the License is distributed on an
22 | ~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
23 | ~~ KIND, either express or implied. See the License for the
24 | ~~ specific language governing permissions and limitations
25 | ~~ under the License.
26 |
27 | ~~ NOTE: For help with the syntax of this file, see:
28 | ~~ http://maven.apache.org/doxia/references/apt-format.html
29 |
30 |
31 | Maven JXR
32 |
33 | Maven JXR project (formally Java Cross Reference) is a library to analyze a set of Java
34 | source files and produce documentation in HTML format <à la Javadoc>.
35 |
36 | Take a look at this {{{./xref/index.html}JXR report}} to see an example.
37 |
38 | * Main Features
39 |
40 | * Supports JDK 1.4+
41 |
42 | * Complementary tool for Javadoc
43 |
44 | * Easy configuration for color, style or template
45 |
46 | * Fully integrated with {{{./maven-jxr-plugin/}Maven}}
47 |
48 | * Brief History
49 |
50 | The original JXR code was merged in 2004 with the Javasrc project from the defunct
51 | {{{http://jakarta.apache.org/alexandria}Jakarta Alexandria}} project.
52 | The code was first maintained within the Maven 1 JXR plugin. In September 2005, it
53 | was voted to fork the base and create a separate library.
54 |
55 | * Examples
56 |
57 | The following example shows how to use Maven JXR in more advanced use cases:
58 |
59 | * {{{./examples/java.html}Using Maven JXR in Java}}
60 |
--------------------------------------------------------------------------------
/src/site/fml/faq.fml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
22 |
26 |
27 |
28 | Is it possible to convert other source files than Java to HTML?
29 |
30 |
31 | Not yet but it is on the roadmap.
32 |
33 |
34 |
35 |
36 | Is an Ant task available?
37 |
38 |
39 | Not yet. Patches are always welcome!
40 |
41 |
42 |
43 |
44 |
--------------------------------------------------------------------------------
/src/site/resources/download.cgi:
--------------------------------------------------------------------------------
1 | #!/bin/sh
2 | #
3 | # Licensed to the Apache Software Foundation (ASF) under one
4 | # or more contributor license agreements. See the NOTICE file
5 | # distributed with this work for additional information
6 | # regarding copyright ownership. The ASF licenses this file
7 | # to you under the Apache License, Version 2.0 (the
8 | # "License"); you may not use this file except in compliance
9 | # with the License. You may obtain a copy of the License at
10 | #
11 | # http://www.apache.org/licenses/LICENSE-2.0
12 | #
13 | # Unless required by applicable law or agreed to in writing,
14 | # software distributed under the License is distributed on an
15 | # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16 | # KIND, either express or implied. See the License for the
17 | # specific language governing permissions and limitations
18 | # under the License.
19 | #
20 | # Just call the standard mirrors.cgi script. It will use download.html
21 | # as the input template.
22 | exec /www/www.apache.org/dyn/mirrors/mirrors.cgi $*
--------------------------------------------------------------------------------
/src/site/site.xml:
--------------------------------------------------------------------------------
1 |
2 |
3 |
21 |
22 |
26 |
27 |
35 |
36 |
39 |
40 |
41 |
42 |
43 |
--------------------------------------------------------------------------------