Qualify rust trait template comments (#21527)

Author: dani-garcia

modules/openapi-generator/src/main/resources/rust/reqwest-trait/api.mustache

@@ -26,11 +26,11 @@ pub trait {{{classname}}}: Send + Sync {
     /// {{{notes}}}
     {{/notes.empty}}
 {{#vendorExtensions.x-group-parameters}}
-    async fn {{{operationId}}}(&self, {{#allParams}}{{#-first}} params: {{{operationIdCamelCase}}}Params {{/-first}}{{/allParams}}{{! 
+    async fn {{{operationId}}}(&self, {{#allParams}}{{#-first}} params: {{{operationIdCamelCase}}}Params {{/-first}}{{/allParams}}{{!
     ### Function return type
     }}) -> Result<{{!
     ### Multi response support
-    }}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{! 
+    }}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{!
     ### Regular return type
     }}{{^supportMultipleResponses}}{{^returnType}}(){{/returnType}}{{{returnType}}}{{/supportMultipleResponses}}{{!
     ### Error Type
@@ -39,27 +39,27 @@ pub trait {{{classname}}}: Send + Sync {
 {{^vendorExtensions.x-group-parameters}}
     async fn {{{operationId}}}{{!
     ### Lifetimes
-    }}<{{#allParams}}'{{#lambda.lifetimeName}}{{{paramName}}}{{/lambda.lifetimeName}}{{^-last}}, {{/-last}}{{/allParams}}>{{! 
+    }}<{{#allParams}}'{{#lambda.lifetimeName}}{{{paramName}}}{{/lambda.lifetimeName}}{{^-last}}, {{/-last}}{{/allParams}}>{{!
     ### Function parameter names
-    }}(&self, {{#allParams}}{{{paramName}}}: {{! 
+    }}(&self, {{#allParams}}{{{paramName}}}: {{!
     ### Option Start
-    }}{{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{! 
+    }}{{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{!
     ### &str and Vec<&str>
-    }}{{#isString}}{{#isArray}}Vec<{{/isArray}}{{^isUuid}}&'{{#lambda.lifetimeName}}{{{paramName}}}{{/lambda.lifetimeName}} str{{/isUuid}}{{#isArray}}>{{/isArray}}{{/isString}}{{! 
+    }}{{#isString}}{{#isArray}}Vec<{{/isArray}}{{^isUuid}}&'{{#lambda.lifetimeName}}{{{paramName}}}{{/lambda.lifetimeName}} str{{/isUuid}}{{#isArray}}>{{/isArray}}{{/isString}}{{!
     ### UUIDs
-    }}{{#isUuid}}{{#isArray}}Vec<{{/isArray}}&str{{#isArray}}>{{/isArray}}{{/isUuid}}{{! 
+    }}{{#isUuid}}{{#isArray}}Vec<{{/isArray}}&str{{#isArray}}>{{/isArray}}{{/isUuid}}{{!
     ### Models and primative types
-    }}{{^isString}}{{^isUuid}}{{^isPrimitiveType}}{{^isContainer}}models::{{/isContainer}}{{/isPrimitiveType}}{{{dataType}}}{{/isUuid}}{{/isString}}{{! 
+    }}{{^isString}}{{^isUuid}}{{^isPrimitiveType}}{{^isContainer}}models::{{/isContainer}}{{/isPrimitiveType}}{{{dataType}}}{{/isUuid}}{{/isString}}{{!
     ### Option End
-    }}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{! 
+    }}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{!
     ### Comma for next arguement
     }}{{^-last}}, {{/-last}}{{/allParams}}{{!
     ### Function return type
-    }}) -> Result<{{! 
+    }}) -> Result<{{!
     ### Multi response support
-    }}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{! 
+    }}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{!
     ### Regular return type
-    }}{{^supportMultipleResponses}}{{^returnType}}(){{/returnType}}{{{returnType}}}{{/supportMultipleResponses}}{{! 
+    }}{{^supportMultipleResponses}}{{^returnType}}(){{/returnType}}{{{returnType}}}{{/supportMultipleResponses}}{{!
     ### Error Type
     }}, Error<{{{operationIdCamelCase}}}Error>>;
 {{/vendorExtensions.x-group-parameters}}
@@ -83,7 +83,7 @@ impl {{classname}}Client {
 {{#vendorExtensions.x-group-parameters}}
 {{#allParams}}
 {{#-first}}
-/// struct for passing parameters to the method [`{{operationId}}`]
+/// struct for passing parameters to the method [`{{{classname}}}::{{operationId}}`]
 #[derive(Clone, Debug)]
 {{#useBonBuilder}}
 #[cfg_attr(feature = "bon", derive(::bon::Builder))]
@@ -149,7 +149,7 @@ impl {{classname}} for {{classname}}Client {
     ### Lifetimes
     }}<{{#allParams}}'{{#lambda.lifetimeName}}{{{paramName}}}{{/lambda.lifetimeName}}{{^-last}}, {{/-last}}{{/allParams}}>{{!
     ### Function parameter names
-    }}(&self, {{#allParams}}{{{paramName}}}: {{! 
+    }}(&self, {{#allParams}}{{{paramName}}}: {{!
     ### Option Start
     }}{{^required}}Option<{{/required}}{{#required}}{{#isNullable}}Option<{{/isNullable}}{{/required}}{{!
     ### &str and Vec<&str>
@@ -161,9 +161,9 @@ impl {{classname}} for {{classname}}Client {
     ### Option End
     }}{{^required}}>{{/required}}{{#required}}{{#isNullable}}>{{/isNullable}}{{/required}}{{!
     ### Comma for next arguement
-    }}{{^-last}}, {{/-last}}{{/allParams}}{{! 
+    }}{{^-last}}, {{/-last}}{{/allParams}}{{!
     ### Function return type
-    }}) -> Result<{{! 
+    }}) -> Result<{{!
     ### Multi response support
     }}{{#supportMultipleResponses}}ResponseContent<{{{operationIdCamelCase}}}Success>{{/supportMultipleResponses}}{{!
     ### Regular return type
@@ -516,7 +516,7 @@ impl {{classname}} for {{classname}}Client {
 {{#supportMultipleResponses}}
 {{#operations}}
 {{#operation}}
-/// struct for typed successes of method [`{{operationId}}`]
+/// struct for typed successes of method [`{{{classname}}}::{{operationId}}`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum {{{operationIdCamelCase}}}Success {
@@ -536,7 +536,7 @@ pub enum {{{operationIdCamelCase}}}Success {
 {{/supportMultipleResponses}}
 {{#operations}}
 {{#operation}}
-/// struct for typed errors of method [`{{operationId}}`]
+/// struct for typed errors of method [`{{{classname}}}::{{operationId}}`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum {{{operationIdCamelCase}}}Error {

samples/client/petstore/rust/reqwest-trait/petstore/src/apis/fake_api.rs

@@ -82,7 +82,7 @@ impl FakeApi for FakeApiClient {
 
 }
 
-/// struct for typed errors of method [`test_nullable_required_param`]
+/// struct for typed errors of method [`FakeApi::test_nullable_required_param`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum TestNullableRequiredParamError {

samples/client/petstore/rust/reqwest-trait/petstore/src/apis/pet_api.rs

@@ -511,39 +511,39 @@ impl PetApi for PetApiClient {
 
 }
 
-/// struct for typed errors of method [`add_pet`]
+/// struct for typed errors of method [`PetApi::add_pet`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum AddPetError {
     Status405(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`delete_pet`]
+/// struct for typed errors of method [`PetApi::delete_pet`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum DeletePetError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`find_pets_by_status`]
+/// struct for typed errors of method [`PetApi::find_pets_by_status`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum FindPetsByStatusError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`find_pets_by_tags`]
+/// struct for typed errors of method [`PetApi::find_pets_by_tags`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum FindPetsByTagsError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`get_pet_by_id`]
+/// struct for typed errors of method [`PetApi::get_pet_by_id`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum GetPetByIdError {
@@ -552,23 +552,23 @@ pub enum GetPetByIdError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`pets_explode_post`]
+/// struct for typed errors of method [`PetApi::pets_explode_post`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum PetsExplodePostError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`pets_post`]
+/// struct for typed errors of method [`PetApi::pets_post`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum PetsPostError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`update_pet`]
+/// struct for typed errors of method [`PetApi::update_pet`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum UpdatePetError {
@@ -578,15 +578,15 @@ pub enum UpdatePetError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`update_pet_with_form`]
+/// struct for typed errors of method [`PetApi::update_pet_with_form`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum UpdatePetWithFormError {
     Status405(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`upload_file`]
+/// struct for typed errors of method [`PetApi::upload_file`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum UploadFileError {

samples/client/petstore/rust/reqwest-trait/petstore/src/apis/store_api.rs

@@ -209,7 +209,7 @@ impl StoreApi for StoreApiClient {
 
 }
 
-/// struct for typed errors of method [`delete_order`]
+/// struct for typed errors of method [`StoreApi::delete_order`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum DeleteOrderError {
@@ -218,14 +218,14 @@ pub enum DeleteOrderError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`get_inventory`]
+/// struct for typed errors of method [`StoreApi::get_inventory`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum GetInventoryError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`get_order_by_id`]
+/// struct for typed errors of method [`StoreApi::get_order_by_id`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum GetOrderByIdError {
@@ -234,7 +234,7 @@ pub enum GetOrderByIdError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`place_order`]
+/// struct for typed errors of method [`StoreApi::place_order`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum PlaceOrderError {

samples/client/petstore/rust/reqwest-trait/petstore/src/apis/testing_api.rs

@@ -167,21 +167,21 @@ impl TestingApi for TestingApiClient {
 
 }
 
-/// struct for typed errors of method [`tests_all_of_with_one_model_get`]
+/// struct for typed errors of method [`TestingApi::tests_all_of_with_one_model_get`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum TestsAllOfWithOneModelGetError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`tests_file_response_get`]
+/// struct for typed errors of method [`TestingApi::tests_file_response_get`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum TestsFileResponseGetError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`tests_type_testing_get`]
+/// struct for typed errors of method [`TestingApi::tests_type_testing_get`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum TestsTypeTestingGetError {

samples/client/petstore/rust/reqwest-trait/petstore/src/apis/user_api.rs

@@ -368,31 +368,31 @@ impl UserApi for UserApiClient {
 
 }
 
-/// struct for typed errors of method [`create_user`]
+/// struct for typed errors of method [`UserApi::create_user`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum CreateUserError {
     DefaultResponse(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`create_users_with_array_input`]
+/// struct for typed errors of method [`UserApi::create_users_with_array_input`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum CreateUsersWithArrayInputError {
     DefaultResponse(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`create_users_with_list_input`]
+/// struct for typed errors of method [`UserApi::create_users_with_list_input`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum CreateUsersWithListInputError {
     DefaultResponse(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`delete_user`]
+/// struct for typed errors of method [`UserApi::delete_user`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum DeleteUserError {
@@ -401,7 +401,7 @@ pub enum DeleteUserError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`get_user_by_name`]
+/// struct for typed errors of method [`UserApi::get_user_by_name`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum GetUserByNameError {
@@ -410,23 +410,23 @@ pub enum GetUserByNameError {
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`login_user`]
+/// struct for typed errors of method [`UserApi::login_user`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum LoginUserError {
     Status400(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`logout_user`]
+/// struct for typed errors of method [`UserApi::logout_user`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum LogoutUserError {
     DefaultResponse(),
     UnknownValue(serde_json::Value),
 }
 
-/// struct for typed errors of method [`update_user`]
+/// struct for typed errors of method [`UserApi::update_user`]
 #[derive(Debug, Clone, Serialize, Deserialize)]
 #[serde(untagged)]
 pub enum UpdateUserError {