Skip to content
This repository was archived by the owner on Nov 15, 2023. It is now read-only.

Implement storage json metadata #670

Merged
gavofyork merged 4 commits into from
Sep 5, 2018
Merged

Implement storage json metadata #670

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
78238af
`decl_storage!` exposes json metadata about the storage
bkchr Sep 5, 2018
b690b4c
Hide internal macros in the documentation
bkchr Sep 5, 2018
b0b4307
Include the function documentation in the store json metadata
bkchr Sep 5, 2018
f6d7400
Adapt the storage declarations to use doc comments
bkchr Sep 5, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Hide internal macros in the documentation
  • Loading branch information
@bkchr
bkchr committed Sep 5, 2018
commit b690b4c83dde79aff36fb18803cdc9b59f3192e2
17 changes: 14 additions & 3 deletions substrate/runtime-support/src/dispatch.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,6 +218,7 @@ macro_rules! decl_dispatch {
}

#[macro_export]
#[doc(hidden)]
/// Implement a single dispatch modules to create a pairing of a dispatch trait and enum.
macro_rules! __decl_dispatch_module_without_aux {
(
Expand Down Expand Up @@ -262,6 +263,7 @@ macro_rules! __decl_dispatch_module_without_aux {
}

#[macro_export]
#[doc(hidden)]
/// Implement a single dispatch modules to create a pairing of a dispatch trait and enum.
macro_rules! __decl_dispatch_module_with_aux {
(
Expand Down Expand Up @@ -308,6 +310,7 @@ macro_rules! __decl_dispatch_module_with_aux {

/// Implement a single dispatch modules to create a pairing of a dispatch trait and enum.
#[macro_export]
#[doc(hidden)]
macro_rules! __decl_dispatch_module_common {
(
impl for $mod_type:ident<$trait_instance:ident: $trait_name:ident>;
Expand Down Expand Up @@ -419,6 +422,7 @@ macro_rules! __decl_dispatch_module_common {
}

#[macro_export]
#[doc(hidden)]
macro_rules! __impl_decode {
(
$input:expr;
Expand Down Expand Up @@ -452,6 +456,7 @@ macro_rules! __impl_decode {
}

#[macro_export]
#[doc(hidden)]
macro_rules! __impl_encode {
(
$dest:expr;
Expand Down Expand Up @@ -512,7 +517,7 @@ macro_rules! impl_outer_dispatch {
$camelcase ( $crate::dispatch::AuxCallableCallFor<$camelcase> )
,)*
}
impl_outer_dispatch_common! { $call_type, $($camelcase,)* }
__impl_outer_dispatch_common! { $call_type, $($camelcase,)* }
impl $crate::dispatch::AuxDispatchable for $call_type {
type Aux = $aux;
type Trait = $call_type;
Expand Down Expand Up @@ -552,7 +557,7 @@ macro_rules! impl_outer_dispatch {
$camelcase ( $crate::dispatch::CallableCallFor<$camelcase> )
,)*
}
impl_outer_dispatch_common! { $call_type, $($camelcase,)* }
__impl_outer_dispatch_common! { $call_type, $($camelcase,)* }
impl $crate::dispatch::Dispatchable for $call_type {
type Trait = $call_type;
fn dispatch(self) -> $crate::dispatch::Result {
Expand Down Expand Up @@ -580,7 +585,8 @@ macro_rules! impl_outer_dispatch {

/// Implement a meta-dispatch module to dispatch to other dispatchers.
#[macro_export]
macro_rules! impl_outer_dispatch_common {
#[doc(hidden)]
macro_rules! __impl_outer_dispatch_common {
(
$call_type:ident, $( $camelcase:ident, )*
) => {
Expand All @@ -602,6 +608,7 @@ macro_rules! impl_outer_dispatch_common {

/// Implement the `json_metadata` function.
#[macro_export]
#[doc(hidden)]
macro_rules! __impl_json_metadata {
(
impl for $mod_type:ident<$trait_instance:ident: $trait_name:ident>;
Expand All @@ -618,6 +625,7 @@ macro_rules! __impl_json_metadata {

/// Convert the list of calls into their JSON representation, joined by ",".
#[macro_export]
#[doc(hidden)]
macro_rules! __calls_to_json {
// WITHOUT AUX
(
Expand Down Expand Up @@ -679,6 +687,7 @@ macro_rules! __calls_to_json {

/// Convert a list of function into their JSON representation, joined by ",".
#[macro_export]
#[doc(hidden)]
macro_rules! __functions_to_json {
// WITHOUT AUX
(
Expand Down Expand Up @@ -736,6 +745,7 @@ macro_rules! __functions_to_json {

/// Convert a function into its JSON representation.
#[macro_export]
#[doc(hidden)]
macro_rules! __function_to_json {
(
fn $fn_name:ident(
Expand All @@ -759,6 +769,7 @@ macro_rules! __function_to_json {

/// Convert a function documentation attribute into its JSON representation.
#[macro_export]
#[doc(hidden)]
macro_rules! __function_doc_to_json {
(
$prefix_str:tt;
Expand Down