From d9b0fc0e3eec67dfe4a97d9298b15969b2804fab Mon Sep 17 00:00:00 2001 From: Brian Anderson Date: Tue, 19 Oct 2021 16:48:15 -0500 Subject: [PATCH] Remove @brief annotations from Rust API docs (#20769) --- programs/bpf/rust/128bit/src/lib.rs | 2 +- programs/bpf/rust/128bit_dep/src/lib.rs | 2 +- programs/bpf/rust/alloc/src/lib.rs | 2 +- programs/bpf/rust/call_depth/src/lib.rs | 2 +- programs/bpf/rust/custom_heap/src/lib.rs | 2 +- programs/bpf/rust/dep_crate/src/lib.rs | 2 +- programs/bpf/rust/deprecated_loader/src/lib.rs | 2 +- programs/bpf/rust/dup_accounts/src/lib.rs | 2 +- programs/bpf/rust/error_handling/src/lib.rs | 2 +- programs/bpf/rust/external_spend/src/lib.rs | 2 +- programs/bpf/rust/finalize/src/lib.rs | 2 +- programs/bpf/rust/instruction_introspection/src/lib.rs | 2 +- programs/bpf/rust/invoke/src/instructions.rs | 2 +- programs/bpf/rust/invoke/src/lib.rs | 2 +- programs/bpf/rust/invoke/src/processor.rs | 2 +- programs/bpf/rust/invoke_and_error/src/lib.rs | 2 +- programs/bpf/rust/invoke_and_ok/src/lib.rs | 2 +- programs/bpf/rust/invoke_and_return/src/lib.rs | 2 +- programs/bpf/rust/invoked/src/instructions.rs | 2 +- programs/bpf/rust/invoked/src/lib.rs | 2 +- programs/bpf/rust/invoked/src/processor.rs | 2 +- programs/bpf/rust/iter/src/lib.rs | 2 +- programs/bpf/rust/log_data/src/lib.rs | 2 +- programs/bpf/rust/many_args/src/helper.rs | 2 +- programs/bpf/rust/many_args/src/lib.rs | 2 +- programs/bpf/rust/many_args_dep/src/lib.rs | 2 +- programs/bpf/rust/mem/src/entrypoint.rs | 2 +- programs/bpf/rust/mem/src/lib.rs | 2 +- programs/bpf/rust/membuiltins/src/lib.rs | 2 +- programs/bpf/rust/noop/src/lib.rs | 2 +- programs/bpf/rust/panic/src/lib.rs | 2 +- programs/bpf/rust/param_passing/src/lib.rs | 2 +- programs/bpf/rust/param_passing_dep/src/lib.rs | 2 +- programs/bpf/rust/rand/src/lib.rs | 2 +- programs/bpf/rust/realloc/src/instructions.rs | 2 +- programs/bpf/rust/realloc/src/lib.rs | 2 +- programs/bpf/rust/realloc/src/processor.rs | 2 +- programs/bpf/rust/realloc_invoke/src/instructions.rs | 2 +- programs/bpf/rust/realloc_invoke/src/lib.rs | 2 +- programs/bpf/rust/realloc_invoke/src/processor.rs | 2 +- programs/bpf/rust/sanity/src/lib.rs | 2 +- programs/bpf/rust/secp256k1_recover/src/lib.rs | 2 +- programs/bpf/rust/sha/src/lib.rs | 2 +- programs/bpf/rust/sysvar/src/lib.rs | 2 +- programs/bpf/rust/upgradeable/src/lib.rs | 2 +- programs/bpf/rust/upgraded/src/lib.rs | 2 +- sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs | 2 +- sdk/cargo-build-bpf/tests/crates/noop/src/lib.rs | 2 +- sdk/program/src/bpf_loader.rs | 2 +- sdk/program/src/bpf_loader_deprecated.rs | 2 +- sdk/program/src/bpf_loader_upgradeable.rs | 2 +- sdk/program/src/entrypoint.rs | 2 +- sdk/program/src/entrypoint_deprecated.rs | 2 +- sdk/program/src/log.rs | 2 +- sdk/program/src/program_memory.rs | 2 +- sdk/program/src/program_stubs.rs | 2 +- sdk/src/builtins.rs | 2 +- sdk/src/entrypoint_native.rs | 2 +- sdk/src/precompiles.rs | 2 +- web3.js/test/fixtures/noop-program/src/lib.rs | 2 +- 60 files changed, 60 insertions(+), 60 deletions(-) diff --git a/programs/bpf/rust/128bit/src/lib.rs b/programs/bpf/rust/128bit/src/lib.rs index 97840af01..49a44d744 100644 --- a/programs/bpf/rust/128bit/src/lib.rs +++ b/programs/bpf/rust/128bit/src/lib.rs @@ -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}; diff --git a/programs/bpf/rust/128bit_dep/src/lib.rs b/programs/bpf/rust/128bit_dep/src/lib.rs index 75da6b3f5..7c2524990 100644 --- a/programs/bpf/rust/128bit_dep/src/lib.rs +++ b/programs/bpf/rust/128bit_dep/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/alloc/src/lib.rs b/programs/bpf/rust/alloc/src/lib.rs index 1df03a1cf..9f59d6aa9 100644 --- a/programs/bpf/rust/alloc/src/lib.rs +++ b/programs/bpf/rust/alloc/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/call_depth/src/lib.rs b/programs/bpf/rust/call_depth/src/lib.rs index f5ec2168a..7ab2c69b5 100644 --- a/programs/bpf/rust/call_depth/src/lib.rs +++ b/programs/bpf/rust/call_depth/src/lib.rs @@ -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}; diff --git a/programs/bpf/rust/custom_heap/src/lib.rs b/programs/bpf/rust/custom_heap/src/lib.rs index 605afcbdd..3e66d6ecd 100644 --- a/programs/bpf/rust/custom_heap/src/lib.rs +++ b/programs/bpf/rust/custom_heap/src/lib.rs @@ -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, diff --git a/programs/bpf/rust/dep_crate/src/lib.rs b/programs/bpf/rust/dep_crate/src/lib.rs index 12951fe80..9ae79e4c9 100644 --- a/programs/bpf/rust/dep_crate/src/lib.rs +++ b/programs/bpf/rust/dep_crate/src/lib.rs @@ -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}; diff --git a/programs/bpf/rust/deprecated_loader/src/lib.rs b/programs/bpf/rust/deprecated_loader/src/lib.rs index 0a43d330c..f0b611791 100644 --- a/programs/bpf/rust/deprecated_loader/src/lib.rs +++ b/programs/bpf/rust/deprecated_loader/src/lib.rs @@ -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)] diff --git a/programs/bpf/rust/dup_accounts/src/lib.rs b/programs/bpf/rust/dup_accounts/src/lib.rs index 33b55b5ee..5d51922bf 100644 --- a/programs/bpf/rust/dup_accounts/src/lib.rs +++ b/programs/bpf/rust/dup_accounts/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/error_handling/src/lib.rs b/programs/bpf/rust/error_handling/src/lib.rs index 055eb798f..0b0e739fc 100644 --- a/programs/bpf/rust/error_handling/src/lib.rs +++ b/programs/bpf/rust/error_handling/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/external_spend/src/lib.rs b/programs/bpf/rust/external_spend/src/lib.rs index 55abb31d1..6f8572406 100644 --- a/programs/bpf/rust/external_spend/src/lib.rs +++ b/programs/bpf/rust/external_spend/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/finalize/src/lib.rs b/programs/bpf/rust/finalize/src/lib.rs index 50e947afd..674a17bb8 100644 --- a/programs/bpf/rust/finalize/src/lib.rs +++ b/programs/bpf/rust/finalize/src/lib.rs @@ -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)] diff --git a/programs/bpf/rust/instruction_introspection/src/lib.rs b/programs/bpf/rust/instruction_introspection/src/lib.rs index 6e20f7325..628c08b2d 100644 --- a/programs/bpf/rust/instruction_introspection/src/lib.rs +++ b/programs/bpf/rust/instruction_introspection/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/invoke/src/instructions.rs b/programs/bpf/rust/invoke/src/instructions.rs index 8eac54ce5..3800af28b 100644 --- a/programs/bpf/rust/invoke/src/instructions.rs +++ b/programs/bpf/rust/invoke/src/instructions.rs @@ -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; diff --git a/programs/bpf/rust/invoke/src/lib.rs b/programs/bpf/rust/invoke/src/lib.rs index dd82d3307..7da570fcf 100644 --- a/programs/bpf/rust/invoke/src/lib.rs +++ b/programs/bpf/rust/invoke/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/invoke/src/processor.rs b/programs/bpf/rust/invoke/src/processor.rs index b76762c56..f51fe351b 100644 --- a/programs/bpf/rust/invoke/src/processor.rs +++ b/programs/bpf/rust/invoke/src/processor.rs @@ -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)] diff --git a/programs/bpf/rust/invoke_and_error/src/lib.rs b/programs/bpf/rust/invoke_and_error/src/lib.rs index 6b94e82ca..1b24ccb23 100644 --- a/programs/bpf/rust/invoke_and_error/src/lib.rs +++ b/programs/bpf/rust/invoke_and_error/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/invoke_and_ok/src/lib.rs b/programs/bpf/rust/invoke_and_ok/src/lib.rs index 06a47ae5e..fd90130fd 100644 --- a/programs/bpf/rust/invoke_and_ok/src/lib.rs +++ b/programs/bpf/rust/invoke_and_ok/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/invoke_and_return/src/lib.rs b/programs/bpf/rust/invoke_and_return/src/lib.rs index 924fd40a8..9b4b81a6f 100644 --- a/programs/bpf/rust/invoke_and_return/src/lib.rs +++ b/programs/bpf/rust/invoke_and_return/src/lib.rs @@ -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::{ diff --git a/programs/bpf/rust/invoked/src/instructions.rs b/programs/bpf/rust/invoked/src/instructions.rs index 28a7eb347..9bffe66fb 100644 --- a/programs/bpf/rust/invoked/src/instructions.rs +++ b/programs/bpf/rust/invoked/src/instructions.rs @@ -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}, diff --git a/programs/bpf/rust/invoked/src/lib.rs b/programs/bpf/rust/invoked/src/lib.rs index dd82d3307..7da570fcf 100644 --- a/programs/bpf/rust/invoked/src/lib.rs +++ b/programs/bpf/rust/invoked/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/invoked/src/processor.rs b/programs/bpf/rust/invoked/src/processor.rs index b25f2aee1..3b94a69c0 100644 --- a/programs/bpf/rust/invoked/src/processor.rs +++ b/programs/bpf/rust/invoked/src/processor.rs @@ -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")] diff --git a/programs/bpf/rust/iter/src/lib.rs b/programs/bpf/rust/iter/src/lib.rs index efa9825f2..09ce81e5e 100644 --- a/programs/bpf/rust/iter/src/lib.rs +++ b/programs/bpf/rust/iter/src/lib.rs @@ -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}; diff --git a/programs/bpf/rust/log_data/src/lib.rs b/programs/bpf/rust/log_data/src/lib.rs index a28b63bf7..123032d9c 100644 --- a/programs/bpf/rust/log_data/src/lib.rs +++ b/programs/bpf/rust/log_data/src/lib.rs @@ -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")] diff --git a/programs/bpf/rust/many_args/src/helper.rs b/programs/bpf/rust/many_args/src/helper.rs index 5159f8112..86f68bb44 100644 --- a/programs/bpf/rust/many_args/src/helper.rs +++ b/programs/bpf/rust/many_args/src/helper.rs @@ -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::*; diff --git a/programs/bpf/rust/many_args/src/lib.rs b/programs/bpf/rust/many_args/src/lib.rs index 2cf8f3750..0c27b1ba3 100644 --- a/programs/bpf/rust/many_args/src/lib.rs +++ b/programs/bpf/rust/many_args/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/many_args_dep/src/lib.rs b/programs/bpf/rust/many_args_dep/src/lib.rs index 824f7ef84..98d9279c1 100644 --- a/programs/bpf/rust/many_args_dep/src/lib.rs +++ b/programs/bpf/rust/many_args_dep/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/mem/src/entrypoint.rs b/programs/bpf/rust/mem/src/entrypoint.rs index 65d25ef8f..586efa0a7 100644 --- a/programs/bpf/rust/mem/src/entrypoint.rs +++ b/programs/bpf/rust/mem/src/entrypoint.rs @@ -1,4 +1,4 @@ -//! @brief Test mem functions +//! Test mem functions use crate::{run_mem_tests, MemOps}; use solana_program::{ diff --git a/programs/bpf/rust/mem/src/lib.rs b/programs/bpf/rust/mem/src/lib.rs index 91a98a208..a824036f6 100644 --- a/programs/bpf/rust/mem/src/lib.rs +++ b/programs/bpf/rust/mem/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Test mem functions +//! Test mem functions #[cfg(not(feature = "no-entrypoint"))] pub mod entrypoint; diff --git a/programs/bpf/rust/membuiltins/src/lib.rs b/programs/bpf/rust/membuiltins/src/lib.rs index 1ce2ed339..3edba8a5a 100644 --- a/programs/bpf/rust/membuiltins/src/lib.rs +++ b/programs/bpf/rust/membuiltins/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Test builtin mem functions +//! Test builtin mem functions #![cfg(target_arch = "bpf")] #![feature(rustc_private)] diff --git a/programs/bpf/rust/noop/src/lib.rs b/programs/bpf/rust/noop/src/lib.rs index 9ec6a3591..2910fe8a3 100644 --- a/programs/bpf/rust/noop/src/lib.rs +++ b/programs/bpf/rust/noop/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF noop program +//! Example Rust-based BPF noop program extern crate solana_program; use solana_program::{ diff --git a/programs/bpf/rust/panic/src/lib.rs b/programs/bpf/rust/panic/src/lib.rs index 67fc3dbfb..f05ea6389 100644 --- a/programs/bpf/rust/panic/src/lib.rs +++ b/programs/bpf/rust/panic/src/lib.rs @@ -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] diff --git a/programs/bpf/rust/param_passing/src/lib.rs b/programs/bpf/rust/param_passing/src/lib.rs index 9d1002d92..fa81fe5d4 100644 --- a/programs/bpf/rust/param_passing/src/lib.rs +++ b/programs/bpf/rust/param_passing/src/lib.rs @@ -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}; diff --git a/programs/bpf/rust/param_passing_dep/src/lib.rs b/programs/bpf/rust/param_passing_dep/src/lib.rs index fc9c3e432..e5d1fd03c 100644 --- a/programs/bpf/rust/param_passing_dep/src/lib.rs +++ b/programs/bpf/rust/param_passing_dep/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/rand/src/lib.rs b/programs/bpf/rust/rand/src/lib.rs index 4366d2fff..cbae2253d 100644 --- a/programs/bpf/rust/rand/src/lib.rs +++ b/programs/bpf/rust/rand/src/lib.rs @@ -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)] diff --git a/programs/bpf/rust/realloc/src/instructions.rs b/programs/bpf/rust/realloc/src/instructions.rs index 192f75b24..58ba925da 100644 --- a/programs/bpf/rust/realloc/src/instructions.rs +++ b/programs/bpf/rust/realloc/src/instructions.rs @@ -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}, diff --git a/programs/bpf/rust/realloc/src/lib.rs b/programs/bpf/rust/realloc/src/lib.rs index 19bb11f10..e2ecc2406 100644 --- a/programs/bpf/rust/realloc/src/lib.rs +++ b/programs/bpf/rust/realloc/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/realloc/src/processor.rs b/programs/bpf/rust/realloc/src/processor.rs index 7755f5b3c..f4d948216 100644 --- a/programs/bpf/rust/realloc/src/processor.rs +++ b/programs/bpf/rust/realloc/src/processor.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF realloc test program +//! Example Rust-based BPF realloc test program #![cfg(feature = "program")] diff --git a/programs/bpf/rust/realloc_invoke/src/instructions.rs b/programs/bpf/rust/realloc_invoke/src/instructions.rs index 83d026e8d..b47b1dde8 100644 --- a/programs/bpf/rust/realloc_invoke/src/instructions.rs +++ b/programs/bpf/rust/realloc_invoke/src/instructions.rs @@ -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; diff --git a/programs/bpf/rust/realloc_invoke/src/lib.rs b/programs/bpf/rust/realloc_invoke/src/lib.rs index 19bb11f10..e2ecc2406 100644 --- a/programs/bpf/rust/realloc_invoke/src/lib.rs +++ b/programs/bpf/rust/realloc_invoke/src/lib.rs @@ -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; diff --git a/programs/bpf/rust/realloc_invoke/src/processor.rs b/programs/bpf/rust/realloc_invoke/src/processor.rs index 2353a7fad..d004c56f8 100644 --- a/programs/bpf/rust/realloc_invoke/src/processor.rs +++ b/programs/bpf/rust/realloc_invoke/src/processor.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF realloc test program +//! Example Rust-based BPF realloc test program #![cfg(feature = "program")] diff --git a/programs/bpf/rust/sanity/src/lib.rs b/programs/bpf/rust/sanity/src/lib.rs index 578be79e0..129c34464 100644 --- a/programs/bpf/rust/sanity/src/lib.rs +++ b/programs/bpf/rust/sanity/src/lib.rs @@ -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)] diff --git a/programs/bpf/rust/secp256k1_recover/src/lib.rs b/programs/bpf/rust/secp256k1_recover/src/lib.rs index f452bbbf7..2e9ccdbdc 100644 --- a/programs/bpf/rust/secp256k1_recover/src/lib.rs +++ b/programs/bpf/rust/secp256k1_recover/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Secp256k1Recover Syscall test +//! Secp256k1Recover Syscall test extern crate solana_program; use solana_program::{custom_panic_default, msg}; diff --git a/programs/bpf/rust/sha/src/lib.rs b/programs/bpf/rust/sha/src/lib.rs index 3a44b8eed..a3b5e7e7d 100644 --- a/programs/bpf/rust/sha/src/lib.rs +++ b/programs/bpf/rust/sha/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief SHA Syscall test +//! SHA Syscall test extern crate solana_program; use solana_program::{custom_panic_default, msg}; diff --git a/programs/bpf/rust/sysvar/src/lib.rs b/programs/bpf/rust/sysvar/src/lib.rs index eba719eea..a7ef6da22 100644 --- a/programs/bpf/rust/sysvar/src/lib.rs +++ b/programs/bpf/rust/sysvar/src/lib.rs @@ -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)] diff --git a/programs/bpf/rust/upgradeable/src/lib.rs b/programs/bpf/rust/upgradeable/src/lib.rs index d07ef1d16..76a9f759b 100644 --- a/programs/bpf/rust/upgradeable/src/lib.rs +++ b/programs/bpf/rust/upgradeable/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF upgradeable program +//! Example Rust-based BPF upgradeable program extern crate solana_program; use solana_program::{ diff --git a/programs/bpf/rust/upgraded/src/lib.rs b/programs/bpf/rust/upgraded/src/lib.rs index 87c0f8f12..5e5e63d0b 100644 --- a/programs/bpf/rust/upgraded/src/lib.rs +++ b/programs/bpf/rust/upgraded/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF upgraded program +//! Example Rust-based BPF upgraded program extern crate solana_program; use solana_program::{ diff --git a/sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs b/sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs index da12227da..221d4ca85 100644 --- a/sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs +++ b/sdk/cargo-build-bpf/tests/crates/fail/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF noop program +//! Example Rust-based BPF noop program extern crate solana_program; use solana_program::{ diff --git a/sdk/cargo-build-bpf/tests/crates/noop/src/lib.rs b/sdk/cargo-build-bpf/tests/crates/noop/src/lib.rs index ac6c3d6c8..e84a8161d 100644 --- a/sdk/cargo-build-bpf/tests/crates/noop/src/lib.rs +++ b/sdk/cargo-build-bpf/tests/crates/noop/src/lib.rs @@ -1,4 +1,4 @@ -//! @brief Example Rust-based BPF noop program +//! Example Rust-based BPF noop program extern crate solana_program; use solana_program::{ diff --git a/sdk/program/src/bpf_loader.rs b/sdk/program/src/bpf_loader.rs index 1bee67849..aca5e6264 100644 --- a/sdk/program/src/bpf_loader.rs +++ b/sdk/program/src/bpf_loader.rs @@ -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 diff --git a/sdk/program/src/bpf_loader_deprecated.rs b/sdk/program/src/bpf_loader_deprecated.rs index 55e58dbc2..1d4cea89b 100644 --- a/sdk/program/src/bpf_loader_deprecated.rs +++ b/sdk/program/src/bpf_loader_deprecated.rs @@ -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. diff --git a/sdk/program/src/bpf_loader_upgradeable.rs b/sdk/program/src/bpf_loader_upgradeable.rs index 298790e4a..0c18108b6 100644 --- a/sdk/program/src/bpf_loader_upgradeable.rs +++ b/sdk/program/src/bpf_loader_upgradeable.rs @@ -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 diff --git a/sdk/program/src/entrypoint.rs b/sdk/program/src/entrypoint.rs index df34b3584..c5f4ad718 100644 --- a/sdk/program/src/entrypoint.rs +++ b/sdk/program/src/entrypoint.rs @@ -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; diff --git a/sdk/program/src/entrypoint_deprecated.rs b/sdk/program/src/entrypoint_deprecated.rs index 02b904895..a289b8b65 100644 --- a/sdk/program/src/entrypoint_deprecated.rs +++ b/sdk/program/src/entrypoint_deprecated.rs @@ -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' diff --git a/sdk/program/src/log.rs b/sdk/program/src/log.rs index 8683d6ec1..a20524192 100644 --- a/sdk/program/src/log.rs +++ b/sdk/program/src/log.rs @@ -1,4 +1,4 @@ -//! @brief Solana Rust-based BPF program logging +//! Solana Rust-based BPF program logging use crate::account_info::AccountInfo; diff --git a/sdk/program/src/program_memory.rs b/sdk/program/src/program_memory.rs index b213aa034..1d0723206 100644 --- a/sdk/program/src/program_memory.rs +++ b/sdk/program/src/program_memory.rs @@ -1,4 +1,4 @@ -//! @brief Solana Rust-based BPF memory operations +//! Solana Rust-based BPF memory operations /// Memcpy /// diff --git a/sdk/program/src/program_stubs.rs b/sdk/program/src/program_stubs.rs index c3e9e478e..901e1aa70 100644 --- a/sdk/program/src/program_stubs.rs +++ b/sdk/program/src/program_stubs.rs @@ -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"))] diff --git a/sdk/src/builtins.rs b/sdk/src/builtins.rs index 7dddb2141..a86966ecb 100644 --- a/sdk/src/builtins.rs +++ b/sdk/src/builtins.rs @@ -1,4 +1,4 @@ -//! @brief Solana builtin helper macros +//! Solana builtin helper macros #[rustversion::since(1.46.0)] #[macro_export] diff --git a/sdk/src/entrypoint_native.rs b/sdk/src/entrypoint_native.rs index 469371321..1573df29d 100644 --- a/sdk/src/entrypoint_native.rs +++ b/sdk/src/entrypoint_native.rs @@ -1,4 +1,4 @@ -//! @brief Solana Native program entry point +//! Solana Native program entry point use crate::{instruction::InstructionError, keyed_account::KeyedAccount, pubkey::Pubkey}; diff --git a/sdk/src/precompiles.rs b/sdk/src/precompiles.rs index 2d7618b1d..5262c2923 100644 --- a/sdk/src/precompiles.rs +++ b/sdk/src/precompiles.rs @@ -1,4 +1,4 @@ -//! @brief Solana precompiled programs +//! Solana precompiled programs #![cfg(feature = "full")] diff --git a/web3.js/test/fixtures/noop-program/src/lib.rs b/web3.js/test/fixtures/noop-program/src/lib.rs index 94893aa62..b439d931e 100644 --- a/web3.js/test/fixtures/noop-program/src/lib.rs +++ b/web3.js/test/fixtures/noop-program/src/lib.rs @@ -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::{