Generate rustdocs from .proto file comments (#10)

* generate rustdoc comments from .proto file comments

* move imports to top of file
This commit is contained in:
John Doneth
2019-09-25 20:51:12 -04:00
committed by Lucio Franco
parent 646796f248
commit 36d0b1cb04
3 changed files with 35 additions and 1 deletions
+27 -1
View File
@@ -25,8 +25,9 @@
//! }
//! ```
use proc_macro2::TokenStream;
use proc_macro2::{TokenStream, Delimiter, Group, Ident, Literal, Punct, Spacing, Span};
use prost_build::Config;
use quote::TokenStreamExt;
#[cfg(feature = "rustfmt")]
use std::process::Command;
@@ -199,3 +200,28 @@ impl prost_build::ServiceGenerator for ServiceGenerator {
}
}
}
// Generate a singular line of a doc comment
fn generate_doc_comment(comment: &str, stream: &mut TokenStream) {
let mut doc_stream = TokenStream::new();
doc_stream.append(Ident::new("doc", Span::call_site()));
doc_stream.append(Punct::new('=', Spacing::Alone));
doc_stream.append(Literal::string(&comment));
let group = Group::new(Delimiter::Bracket, doc_stream);
stream.append(Punct::new('#', Spacing::Alone));
stream.append(group);
}
// Generate a larger doc comment composed of many lines of doc comments
fn generate_doc_comments<T: AsRef<str>>(comments: &[T]) -> TokenStream {
let mut stream = TokenStream::new();
for comment in comments {
generate_doc_comment(comment.as_ref(), &mut stream);
}
stream
}