Add docs to declare_id macro (#10673)

Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
This commit is contained in:
Tyera Eulberg
2020-06-17 19:19:06 -06:00
committed by GitHub
parent 7eb61074ab
commit 58e6a5c281

View File

@ -41,12 +41,15 @@ impl ToTokens for Id {
fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) { fn to_tokens(&self, tokens: &mut proc_macro2::TokenStream) {
let id = &self.0; let id = &self.0;
tokens.extend(quote! { tokens.extend(quote! {
/// The static program ID
pub static ID: ::solana_sdk::pubkey::Pubkey = #id; pub static ID: ::solana_sdk::pubkey::Pubkey = #id;
/// Confirms that a given pubkey is equivalent to the program ID
pub fn check_id(id: &::solana_sdk::pubkey::Pubkey) -> bool { pub fn check_id(id: &::solana_sdk::pubkey::Pubkey) -> bool {
id == &ID id == &ID
} }
/// Returns the program ID
pub fn id() -> ::solana_sdk::pubkey::Pubkey { pub fn id() -> ::solana_sdk::pubkey::Pubkey {
ID ID
} }