Azure / Azure/azure-functions-java-library
Incorrect Javadoc comment in HttpTrigger.java
- Vorherrschende Sprache
- Java
- Sterne
- 45
- Forks
- 49
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Rechercherichtung
Öffne src/main/java/com/microsoft/azure/functions/annotation/HttpTrigger.java in der Nähe von Zeile 140 und vergleiche das Javadoc-Beispiel mit der verknüpften Routendokumentation. Korrigiere den Rückgabetyp des Beispiels, sodass er dem angegebenen Methodentyp entspricht, und überprüfe anschließend, dass das Javadoc-Beispiel den gemeldeten Kompilierungsfehler nicht mehr enthält.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- java
- Bereich
- documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 1/5
- Geschätzter Aufwand
- Unter einer Stunde
- Aktivitätsstatus
- Veraltet
- Klarheit
- Klar beschrieben
- Anfängerfreundlichkeit
- 45/100