Skip to content

Kdoc for router function in KotlinDSL is refers to filter not router (KotlinIntegrationFlowDefinition) #3800

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.

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

Closed
frayneposset opened this issue May 17, 2022 · 1 comment

Comments

@frayneposset
Copy link

In what version(s) of Spring Integration are you seeing this issue?

5.5.11

Describe the bug

The Kdoc for the following two functions appears to have been copy pasted from the filter Kdoc and not changed. See below.

	/**
	 * Inline function for [IntegrationFlowDefinition.filter] providing a `filter<MyTypeIn>()` variant
	 * with reified generic type.
	 */
	inline fun <reified P> route(crossinline function: (P) -> Any?) {
		route(function) { }
	}

	/**
	 * Inline function for [IntegrationFlowDefinition.filter] providing a `filter<MyTypeIn>()` variant
	 * with reified generic type.
	 */
	inline fun <reified P, T> route(
		crossinline function: (P) -> T,
		crossinline configurer: KotlinRouterSpec<T, MethodInvokingRouter>.() -> Unit
	) {

		this.delegate.route(P::class.java, { function(it) }) { configurer(KotlinRouterSpec(it)) }
	}

To Reproduce

N/A - documentation issue

Expected behavior

N/A - documentation issue

Sample

N/A - documentation issue

@frayneposset frayneposset added status: waiting-for-triage The issue need to be evaluated and its future decided type: bug labels May 17, 2022
@artembilan artembilan added type: documentation and removed status: waiting-for-triage The issue need to be evaluated and its future decided labels May 17, 2022
@artembilan artembilan added this to the 6.0 M3 milestone May 17, 2022
@artembilan
Copy link
Member

@frayneposset ,

If you are good, consider to contribute the respective fix: https://github.com/spring-projects/spring-integration/blob/main/CONTRIBUTING.adoc.

We are having release today.

artembilan added a commit that referenced this issue May 17, 2022
Fixes #3800

* Mention `Message` as a type for reified generic argument in Kotlin DSL docs

**Cherry-pick to `5.5.x`**
GregBragg added a commit to GregBragg/spring-integration that referenced this issue May 17, 2022
GregBragg added a commit to GregBragg/spring-integration that referenced this issue May 17, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants