Azure / Azure/azure-functions-java-library
Incorrect Javadoc comment in HttpTrigger.java
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Java
- Estrellas
- 45
- Forks
- 49
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Descripción
The following Javadoc describes the HttpTriger route method, but the sample described is incorrect and causes a compile error.
The correct method type is HttpResponseMessage, not HttpResponseMessage<String>.
@FunctionName("routeTest")
public HttpResponseMessage<String> routeTest(
@HttpTrigger(name = "req",
methods = {HttpMethod.GET},
authLevel = AuthorizationLevel.ANONYMOUS,
route = "products/{category:alpha}/{id:int}")
HttpRequestMessage<Optional<String>> request,
@BindingName("category") String category,
@BindingName("id") int id,
final ExecutionContext context
) {
....
context.getLogger().info("We have " + category + " with id " + id);
....
}
This Javadoc is probably auto-generated from the following link.
Please fix it.
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Abre src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java cerca de la línea 140 y compara el ejemplo de Javadoc con la documentación de rutas enlazada. Corrige el tipo de retorno del ejemplo para que coincida con el tipo de método indicado y, después, verifica que el ejemplo de Javadoc ya no contenga el error de compilación informado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 1/5
- Tiempo estimado
- Menos de una hora
- Estado de actividad
- Estancado
- Claridad
- Bien especificado
- Aptitud para principiantes
- 45/100