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

This commit is contained in:
Brian Anderson 2021-10-19 16:48:15 -05:00 committed by GitHub
parent 72e1efb847
commit d9b0fc0e3e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
60 changed files with 60 additions and 60 deletions

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
extern crate solana_program;
use solana_program::{custom_panic_default, entrypoint::SUCCESS};

View File

@ -1,4 +1,4 @@
//! @brief Solana Rust-based BPF program utility functions and types
//! Solana Rust-based BPF program utility functions and types
extern crate solana_program;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that test dynamic memory allocation
//! Example Rust-based BPF program that test dynamic memory allocation
#[macro_use]
extern crate alloc;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that tests call depth and stack usage
//! Example Rust-based BPF program that tests call depth and stack usage
use solana_program::{custom_panic_default, entrypoint::SUCCESS, msg};

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF that tests out using a custom heap
//! Example Rust-based BPF that tests out using a custom heap
use solana_program::{
account_info::AccountInfo,

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests dependent crates
//! Example Rust-based BPF program tests dependent crates
extern crate solana_program;
use byteorder::{ByteOrder, LittleEndian};

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that supports the deprecated loader
//! Example Rust-based BPF program that supports the deprecated loader
#![allow(unreachable_code)]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that tests duplicate accounts passed via accounts
//! Example Rust-based BPF program that tests duplicate accounts passed via accounts
extern crate solana_program;
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that exercises error handling
//! Example Rust-based BPF program that exercises error handling
extern crate solana_program;
use num_derive::FromPrimitive;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that moves a lamport from one account to another
//! Example Rust-based BPF program that moves a lamport from one account to another
extern crate solana_program;
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF sanity program that finalizes a BPF program
//! Example Rust-based BPF sanity program that finalizes a BPF program
#![allow(unreachable_code)]

View File

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

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
pub const TEST_SUCCESS: u8 = 1;
pub const TEST_PRIVILEGE_ESCALATION_SIGNER: u8 = 2;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
pub mod instructions;
pub mod processor;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
#![cfg(feature = "program")]
#![allow(unreachable_code)]

View File

@ -1,4 +1,4 @@
//! @brief Invokes an instruction and returns an error, the instruction invoked
//! Invokes an instruction and returns an error, the instruction invoked
//! uses the instruction data provided and all the accounts
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Invokes an instruction and returns an error, the instruction invoked
//! Invokes an instruction and returns an error, the instruction invoked
//! uses the instruction data provided and all the accounts
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Invokes an instruction and returns an error, the instruction invoked
//! Invokes an instruction and returns an error, the instruction invoked
//! uses the instruction data provided and all the accounts
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
use solana_program::{
instruction::{AccountMeta, Instruction},

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
pub mod instructions;
pub mod processor;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that issues a cross-program-invocation
//! Example Rust-based BPF program that issues a cross-program-invocation
#![cfg(feature = "program")]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
extern crate solana_program;
use solana_program::{custom_panic_default, entrypoint::SUCCESS, msg};

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that uses sol_log_data syscall
//! Example Rust-based BPF program that uses sol_log_data syscall
#![cfg(feature = "program")]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
extern crate solana_program;
use solana_program::log::*;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
mod helper;
extern crate solana_program;

View File

@ -1,4 +1,4 @@
//! @brief Solana Rust-based BPF program utility functions and types
//! Solana Rust-based BPF program utility functions and types
extern crate solana_program;
use solana_program::msg;

View File

@ -1,4 +1,4 @@
//! @brief Test mem functions
//! Test mem functions
use crate::{run_mem_tests, MemOps};
use solana_program::{

View File

@ -1,4 +1,4 @@
//! @brief Test mem functions
//! Test mem functions
#[cfg(not(feature = "no-entrypoint"))]
pub mod entrypoint;

View File

@ -1,4 +1,4 @@
//! @brief Test builtin mem functions
//! Test builtin mem functions
#![cfg(target_arch = "bpf")]
#![feature(rustc_private)]

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 Example Rust-based BPF program that panics
//! Example Rust-based BPF program that panics
#[cfg(all(feature = "custom-panic", target_arch = "bpf"))]
#[no_mangle]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
extern crate solana_program;
use solana_bpf_rust_param_passing_dep::{Data, TestDep};

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program tests loop iteration
//! Example Rust-based BPF program tests loop iteration
extern crate solana_program;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that tests rand behavior
//! Example Rust-based BPF program that tests rand behavior
#![allow(unreachable_code)]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
use solana_program::{
instruction::{AccountMeta, Instruction},

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
pub mod instructions;
pub mod processor;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
#![cfg(feature = "program")]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
pub const INVOKE_REALLOC_ZERO_RO: u8 = 0;
pub const INVOKE_REALLOC_ZERO: u8 = 1;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
pub mod instructions;
pub mod processor;

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF realloc test program
//! Example Rust-based BPF realloc test program
#![cfg(feature = "program")]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF sanity program that prints out the parameters passed to it
//! Example Rust-based BPF sanity program that prints out the parameters passed to it
#![allow(unreachable_code)]

View File

@ -1,4 +1,4 @@
//! @brief Secp256k1Recover Syscall test
//! Secp256k1Recover Syscall test
extern crate solana_program;
use solana_program::{custom_panic_default, msg};

View File

@ -1,4 +1,4 @@
//! @brief SHA Syscall test
//! SHA Syscall test
extern crate solana_program;
use solana_program::{custom_panic_default, msg};

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that tests sysvar use
//! Example Rust-based BPF program that tests sysvar use
extern crate solana_program;
#[allow(deprecated)]

View File

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

View File

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

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 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};

View File

@ -1,4 +1,4 @@
//! @brief Solana precompiled programs
//! Solana precompiled programs
#![cfg(feature = "full")]

View File

@ -1,4 +1,4 @@
//! @brief Example Rust-based BPF program that prints out the parameters passed to it
//! Example Rust-based BPF program that prints out the parameters passed to it
use solana_program::{