VienDesu/schemars
3
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add doc comments example

Browse source
This commit is contained in:
Graham Esau 2019-12-28 15:38:41 +00:00
parent 51a0966ec1
commit 79155cddf5
5 changed files with 235 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

13
docs/examples/6-doc_comments.md Normal file
View file

@ -0,0 +1,13 @@
---
layout: default
title: Doc Comments
parent: Examples
nav_order: 5
summary: Giving schemas a custom title and/or description using doc comments.
---
# Setting a Custom Title and/or Description Using Doc Comments
If a struct, variant or field has any [doc comments](https://doc.rust-lang.org/stable/rust-by-example/meta/doc.html#doc-comments) (or [`doc` attributes](https://doc.rust-lang.org/rustdoc/the-doc-attribute.html)), then these will be used as the generated schema's `description`. If the first line is an ATX-style markdown heading (i.e. it begins with a # character), then it will be used as the schema's `title`, and the remaining lines will be the `description`.
{% include example.md name="doc_comments" %}