Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[MCHANGES-436] Clean up Javadoc #59

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
+5 −10
Open

[MCHANGES-436] Clean up Javadoc #59

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1741219
Clean up Javadoc
elharo Nov 23, 2024
7c7b302
getSiteLocales(String)
elharo Dec 1, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 6 additions & 11 deletions src/main/java/org/apache/maven/reporting/AbstractMavenReport.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
*<p>
* A plugin may use any subdirectory structure (either using a hard-coded name or, ideally, an additional
* user-defined mojo parameter with a default value) to generate multi-page reports or external reports with the
* main output file (entry point) denoted by {@link #getOutputName()}.
* main output file (entry point) denoted by {@link #getOutputPath}.
*/
@Parameter(defaultValue = "${project.build.directory}/reports", required = true)
protected File outputDirectory;
Expand Down Expand Up @@ -140,10 +140,10 @@ public abstract class AbstractMavenReport extends AbstractMojo implements MavenM
protected File siteDirectory;

/**
* The locale to use when the report generation is invoked directly as a standalone Mojo.
* The locale to use when the report generation is invoked directly as a standalone Mojo.
*
* @see SiteTool#DEFAULT_LOCALE
* @see SiteTool#getSiteLocales(String)
* @see SiteTool#getSiteLocales
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is correct JavaDoc link ....

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is a shortcut since there's no overloading here, but I can put it back.

*/
@Parameter(defaultValue = "default")
protected String locale;
Expand Down Expand Up @@ -331,8 +331,8 @@ private SiteRenderingContext createSiteRenderingContext(Locale locale)
/**
* Generate a report.
*
* @param sink the sink to use for the generation.
* @param locale the wanted locale to generate the report, could be null.
* @param sink the sink to use for the generation
* @param locale the wanted locale to generate the report, could be null
* @throws MavenReportException if any
* @deprecated use {@link #generate(Sink, SinkFactory, Locale)} instead.
*/
Expand All @@ -344,11 +344,6 @@ public void generate(Sink sink, Locale locale) throws MavenReportException {

/**
* This method is called when the report generation is invoked by maven-site-plugin.
*
* @param sink
* @param sinkFactory
* @param locale
* @throws MavenReportException
*/
@Override
public void generate(Sink sink, SinkFactory sinkFactory, Locale locale) throws MavenReportException {
Expand Down Expand Up @@ -413,7 +408,7 @@ protected String getOutputEncoding() {
}

/**
* Gets the locale
* Gets the locale.
*
* @return the locale for this standalone report
*/
Expand Down