Azure / Azure/azure-functions-java-library

Incorrect Javadoc comment in HttpTrigger.java

Aperta
#131 2 commenti 0 reazioni 0 assegnatari Vedi su GitHub
area:java-functions
Lingua principale
Java
Stelle
45
Fork
49
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

The following Javadoc describes the HttpTriger route method, but the sample described is incorrect and causes a compile error.

https://docs.microsoft.com/en-us/java/api/com.microsoft.azure.functions.annotation.httptrigger.route?view=azure-java-stable#com_microsoft_azure_functions_annotation_HttpTrigger_route__

The correct method type is `HttpResponseMessage`, not `HttpResponseMessage`.

```java
@FunctionName("routeTest")
public HttpResponseMessage routeTest(
@HttpTrigger(name = "req",
methods = {HttpMethod.GET},
authLevel = AuthorizationLevel.ANONYMOUS,
route = "products/{category:alpha}/{id:int}")
HttpRequestMessage> 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.

https://github.com/Azure/azure-functions-java-library/blob/dev/src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java#L140

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Direzione di ricerca

Apri src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java intorno alla riga 140 e confronta l’esempio Javadoc con la documentazione delle route collegata. Correggi il tipo restituito dell’esempio in modo che corrisponda al tipo di metodo indicato, quindi verifica che l’esempio Javadoc non contenga più l’errore di compilazione segnalato.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
java
Ambito
documentation
Tipo di issue
Documentazione
Difficoltà
1/5
Tempo stimato
Meno di un'ora
Stato di attività
Ferma
Chiarezza
Specificata chiaramente
Idoneità per principianti
45/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.