Skip to content

Commit

Permalink
reformat rustdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
msrd0 committed Jan 1, 2022
1 parent 6181a61 commit d60a419
Showing 1 changed file with 12 additions and 14 deletions.
26 changes: 12 additions & 14 deletions src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -131,20 +131,18 @@ impl OpenapiSchema {
}
}

/**
This trait needs to be implemented by every type that is being used in the OpenAPI Spec. It gives
access to the [OpenapiSchema] of this type. It is provided for primitive types, String and the
like. For use on your own types, there is a derive macro:
```
# #[macro_use] extern crate openapi_type_derive;
#
#[derive(OpenapiType)]
struct MyResponse {
message: String
}
```
*/
/// This trait needs to be implemented by every type that is being used in the OpenAPI Spec. It gives
/// access to the [OpenapiSchema] of this type. It is provided for primitive types, String and the
/// like. For use on your own types, there is a derive macro:
///
/// ```
/// # #[macro_use] extern crate openapi_type_derive;
/// #
/// #[derive(OpenapiType)]
/// struct MyResponse {
/// message: String
/// }
/// ```
pub trait OpenapiType {
fn schema() -> OpenapiSchema;
}
Expand Down

0 comments on commit d60a419

Please sign in to comment.