Remove @brief annotations from Rust API docs (backport #20769) (#20807)

* Remove @brief annotations from Rust API docs (#20769)

(cherry picked from commit d9b0fc0e3e)

# Conflicts:
#	programs/bpf/rust/invoke/src/instructions.rs
#	programs/bpf/rust/invoke/src/processor.rs
#	programs/bpf/rust/realloc/src/instructions.rs
#	programs/bpf/rust/realloc/src/lib.rs
#	programs/bpf/rust/realloc/src/processor.rs
#	programs/bpf/rust/realloc_invoke/src/instructions.rs
#	programs/bpf/rust/realloc_invoke/src/lib.rs
#	programs/bpf/rust/realloc_invoke/src/processor.rs
#	sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs
#	sdk/src/precompiles.rs

* Fix conflicts

Co-authored-by: Brian Anderson <andersrb@gmail.com>
Co-authored-by: Tyera Eulberg <tyera@solana.com>
This commit is contained in:
mergify[bot]
2021-10-19 19:17:33 -06:00
committed by GitHub
parent 436ec212f4
commit 63e37b2b20
50 changed files with 50 additions and 50 deletions

View File

@@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF noop program
//! Example Rust-based BPF noop program
extern crate solana_program;
use solana_program::{

View File

@@ -1,4 +1,4 @@
//! @brief The latest Solana BPF loader.
//! The latest Solana BPF loader.
//!
//! The BPF loader is responsible for loading, finalizing, and executing BPF
//! programs. Not all networks may support the latest loader. You can use the

View File

@@ -1,4 +1,4 @@
//! @brief The original and now deprecated Solana BPF loader.
//! The original and now deprecated Solana BPF loader.
//!
//! The BPF loader is responsible for loading, finalizing, and executing BPF
//! programs.

View File

@@ -1,4 +1,4 @@
//! @brief An Upgradeable Solana BPF loader.
//! An Upgradeable Solana BPF loader.
//!
//! The upgradeable BPF loader is responsible for deploying, upgrading, and
//! executing BPF programs. The upgradeable loader allows a program's authority

View File

@@ -1,4 +1,4 @@
//! @brief Solana Rust-based BPF program entry point supported by the latest
//! Solana Rust-based BPF program entry point supported by the latest
//! BPFLoader. For more information see './bpf_loader.rs'
extern crate alloc;

View File

@@ -1,5 +1,5 @@
#![allow(clippy::integer_arithmetic)]
//! @brief Solana Rust-based BPF program entry point supported by the original
//! Solana Rust-based BPF program entry point supported by the original
//! and now deprecated BPFLoader. For more information see
//! './bpf_loader_deprecated.rs'

View File

@@ -1,4 +1,4 @@
//! @brief Solana Rust-based BPF program logging
//! Solana Rust-based BPF program logging
use crate::account_info::AccountInfo;

View File

@@ -1,4 +1,4 @@
//! @brief Solana Rust-based BPF memory operations
//! Solana Rust-based BPF memory operations
/// Memcpy
///

View File

@@ -1,4 +1,4 @@
//! @brief Syscall stubs when building for programs for non-BPF targets
//! Syscall stubs when building for programs for non-BPF targets
#![cfg(not(target_arch = "bpf"))]

View File

@@ -1,4 +1,4 @@
//! @brief Solana builtin helper macros
//! Solana builtin helper macros
#[rustversion::since(1.46.0)]
#[macro_export]

View File

@@ -1,4 +1,4 @@
//! @brief Solana Native program entry point
//! Solana Native program entry point
use crate::{instruction::InstructionError, keyed_account::KeyedAccount, pubkey::Pubkey};