Add more documentation

Author: szg251

runtimes/rust/lbr-prelude-derive/src/lib.rs

@@ -1,19 +1,17 @@
-//! Automatically derive Json trait implementations
-//!
-//! Currently we only support a subset of types with an opinionated serialisation scheme. If you
-//! need anything else than what this library provides, it is advised to hand write the
-//! implementation.
-//!
-//! Supported types:
-//! - **unit structs (newtypes)**: this will simply remove the wrapper, and serialize the wrapped value
-//! - **structs**: serialized into a Json Object
-//! - **enums with unnamed fields**: serialized into an object with the following schema: `{"name": string, "fields": any[]}`
-
 use proc_macro::TokenStream;
 use quote::{format_ident, quote};
 use syn::{self, parse_macro_input, DeriveInput};
 
 /// Derive a `Json` trait implementation
+///
+/// Currently we only support a subset of types with an opinionated serialisation scheme. If you
+/// need anything else than what this library provides, it is advised to hand write the
+/// implementation.
+///
+/// Supported types:
+/// - **unit structs (newtypes)**: this will simply remove the wrapper, and serialize the wrapped value
+/// - **structs**: serialized into a Json Object
+/// - **enums with unnamed fields**: serialized into an object with the following schema: `{"name": string, "fields": any[]}`
 #[proc_macro_derive(Json)]
 pub fn derive_json_fn(input: TokenStream) -> TokenStream {
     let ast = parse_macro_input!(input as DeriveInput);