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

Jump to bottom

Format method param JavaDoc in columns #590

Merged
merged 2 commits into from
Jan 4, 2020
Merged

Format method param JavaDoc in columns #590

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7c7c301
Format method param JavaDoc in columns
ppalaga Jan 4, 2020
29684a4
Apply the new formatting rules
ppalaga Jan 4, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
4 changes: 2 additions & 2 deletions .../java/org/apache/camel/quarkus/component/attachments/deployment/AttachmentsProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ FeatureBuildItem feature() {
* Produces the "real" {@link UploadAttacher} thus overriding the default no-op one produced by
* {@code camel-quarkus-core-deployment}.
*
* @param recorder the {@link AttachmentsRecorder}
* @return a new {@link UploadAttacherBuildItem}
* @param recorder the {@link AttachmentsRecorder}
* @return a new {@link UploadAttacherBuildItem}
*/
@Record(ExecutionTime.STATIC_INIT)
@BuildStep
Expand Down
26 changes: 13 additions & 13 deletions ...ore/deployment/src/main/java/org/apache/camel/quarkus/core/deployment/BuildProcessor.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,18 +426,18 @@ CamelMainBuildItem main(
/**
* This method is responsible to start camel-main ar runtime.
*
* @param recorder the recorder.
* @param main a reference to a {@link CamelMain}.
* @param registry a reference to a {@link org.apache.camel.spi.Registry}; note that this parameter is here as
* placeholder to
* ensure the {@link org.apache.camel.spi.Registry} is fully configured before starting camel-main.
* @param executor the {@link org.apache.camel.spi.ReactiveExecutor} to be configured on camel-main, this
* happens during {@link ExecutionTime#RUNTIME_INIT} because the executor may need to start
* threads and so on.
* @param shutdown a reference to a {@link io.quarkus.runtime.ShutdownContext} used to register shutdown logic.
* @param recorder the recorder.
* @param main a reference to a {@link CamelMain}.
* @param registry a reference to a {@link org.apache.camel.spi.Registry}; note that this parameter is here as
* placeholder to
* ensure the {@link org.apache.camel.spi.Registry} is fully configured before starting camel-main.
* @param executor the {@link org.apache.camel.spi.ReactiveExecutor} to be configured on camel-main, this
* happens during {@link ExecutionTime#RUNTIME_INIT} because the executor may need to start
* threads and so on.
* @param shutdown a reference to a {@link io.quarkus.runtime.ShutdownContext} used to register shutdown logic.
* @param startList a placeholder to ensure camel-main start after the ArC container is fully initialized. This
* is required as under the hoods the camel registry may look-up beans form the
* container thus we need it to be fully initialized to avoid unexpected behaviors.
* is required as under the hoods the camel registry may look-up beans form the
* container thus we need it to be fully initialized to avoid unexpected behaviors.
*/
@Record(ExecutionTime.RUNTIME_INIT)
@BuildStep(onlyIf = Flags.MainEnabled.class)
Expand Down Expand Up @@ -465,8 +465,8 @@ public static class Attachments {
* Note that this {@link BuildStep} is effective only if {@code camel-quarkus-attachments} extension is not in
* the class path.
*
* @param recorder the {@link CoreAttachmentsRecorder}
* @return a new {@link UploadAttacherBuildItem}
* @param recorder the {@link CoreAttachmentsRecorder}
* @return a new {@link UploadAttacherBuildItem}
*/
@Overridable
@Record(value = ExecutionTime.STATIC_INIT, optional = true)
Expand Down
4 changes: 2 additions & 2 deletions extensions/core/runtime/src/main/java/org/apache/camel/quarkus/core/UploadAttacher.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@ public interface UploadAttacher {
* {@code message}
*
* @param localFile the uploaded file stored locally
* @param fileName the name of the upload as sent by the client
* @param message the {@link Message} to attach the upload to
* @param fileName the name of the upload as sent by the client
* @param message the {@link Message} to attach the upload to
*/
void attachUpload(File localFile, String fileName, Message message);

Expand Down
6 changes: 3 additions & 3 deletions ...et/runtime/src/main/java/org/apache/camel/quarkus/servlet/runtime/CamelServletConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -86,9 +86,9 @@ public boolean isValid() {
* sets the precedence: the {@link #servletName} gets effective only if it has a non-default value; otherwise
* the {@code key} is returned as the servlet name.
*
* @param key the key used in
* {@link org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets}
* @return the effective servlet name to use
* @param key the key used in
* {@link org.apache.camel.quarkus.servlet.runtime.CamelServletConfig.ServletsConfig#namedServlets}
* @return the effective servlet name to use
*/
public String getEffectiveServletName(final String key) {
return DEFAULT_SERVLET_NAME.equals(servletName) ? key : servletName;
Expand Down
4 changes: 2 additions & 2 deletions ...slt/runtime/src/main/java/org/apache/camel/quarkus/component/xslt/RuntimeUriResolver.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -56,8 +56,8 @@ public Source resolve(String href, String base) throws TransformerException {
}

/**
* @param uri the URI whose translet is seeked
* @return the unqualified translet name associated with the given {@code uri}
* @param uri the URI whose translet is seeked
* @return the unqualified translet name associated with the given {@code uri}
*/
public String getTransletClassName(String uri) {
final String transletClassName = uriToTransletName.get(uri);
Expand Down
2 changes: 1 addition & 1 deletion ...support/test-support/src/main/java/org/apache/camel/quarkus/test/AvailablePortFinder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ private AvailablePortFinder() {
* Gets the next available port.
*
* @throws IllegalStateException if there are no ports available
* @return the available port
* @return the available port
*/
public static int getNextAvailable() {
try (ServerSocket ss = new ServerSocket()) {
Expand Down
6 changes: 3 additions & 3 deletions ...s/support/test-support/src/main/java/org/apache/camel/quarkus/test/EnabledIfProperty.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@
* The name of the property to retrieve.
*
* @return the property name; never <em>blank</em>
* @see org.eclipse.microprofile.config.Config#getValue(String, Class)
* @see org.eclipse.microprofile.config.Config#getValue(String, Class)
*/
String named();

Expand All @@ -48,8 +48,8 @@
* value of the {@link #named} property.
*
* @return the regular expression; never <em>blank</em>
* @see String#matches(String)
* @see java.util.regex.Pattern
* @see String#matches(String)
* @see java.util.regex.Pattern
*/
String matches();

Expand Down
2 changes: 1 addition & 1 deletion poms/build-parent/pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@
<maven-resources-plugin.version>3.1.0</maven-resources-plugin.version>
<docker-maven-plugin.version>0.3.0</docker-maven-plugin.version>
<directory-maven-plugin.version>0.3.1</directory-maven-plugin.version>
<formatter-maven-plugin.version>2.10.0</formatter-maven-plugin.version>
<formatter-maven-plugin.version>2.11.0</formatter-maven-plugin.version>
</properties>

<dependencyManagement>
Expand Down
13 changes: 8 additions & 5 deletions tooling/eclipse-formatter-config.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,13 +60,19 @@
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_method_declaration" value="end_of_line"/>
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_switch" value="end_of_line"/>
<setting id="org.eclipse.jdt.core.formatter.brace_position_for_type_declaration" value="end_of_line"/>
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_names_descriptions" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.align_tags_descriptions_grouped" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.clear_blank_lines" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_comments" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_header" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_html" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_source_code" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.comment.indent_parameter_description" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.indent_return_description" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.indent_root_tags" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_before_root_tags" value="insert"/>
<setting id="org.eclipse.jdt.core.formatter.comment.insert_new_line_for_parameter" value="do not insert"/>
<setting id="org.eclipse.jdt.core.formatter.comment.line_length" value="120"/>
Expand Down Expand Up @@ -265,8 +271,5 @@
<setting id="org.eclipse.jdt.core.formatter.use_on_off_tags" value="true"/>
<setting id="org.eclipse.jdt.core.formatter.disabling_tag" value="CHECKSTYLE:OFF"/>
<setting id="org.eclipse.jdt.core.formatter.enabling_tag" value="CHECKSTYLE:ON"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_block_comments" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_line_comments" value="false"/>
<setting id="org.eclipse.jdt.core.formatter.comment.format_javadoc_comments" value="false"/>
</profile>
</profiles>
2 changes: 1 addition & 1 deletion ...-maven-plugin/src/main/java/org/apache/camel/quarkus/maven/PrepareCatalogQuarkusMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -126,7 +126,7 @@ public class PrepareCatalogQuarkusMojo extends AbstractMojo {
* Execute goal.
*
* @throws MojoExecutionException execution of the main class or one of the
* threads it generated failed.
* threads it generated failed.
* @throws MojoFailureException something bad happened...
*/
@Override
Expand Down
2 changes: 1 addition & 1 deletion ...aven-plugin/src/main/java/org/apache/camel/quarkus/maven/UpdateDocExtensionsListMojo.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -121,7 +121,7 @@ public class UpdateDocExtensionsListMojo extends AbstractMojo {
* Execute goal.
*
* @throws MojoExecutionException execution of the main class or one of the
* threads it generated failed.
* threads it generated failed.
* @throws MojoFailureException something bad happened...
*/
@Override
Expand Down