1010/* *
1111 * EOSIO Contracts
1212 *
13- * @details The design of the EOSIO blockchain calls for a number of smart contracts that are run at a
13+ * The design of the EOSIO blockchain calls for a number of smart contracts that are run at a
1414 * privileged permission level in order to support functions such as block producer registration and
1515 * voting, token staking for CPU and network bandwidth, RAM purchasing, multi-sig, etc. These smart
1616 * contracts are referred to as the system, token, msig and wrap (formerly known as sudo) contracts.
@@ -89,9 +89,7 @@ namespace eosiobios {
8989 public:
9090 using contract::contract;
9191 /* *
92- * New account action
93- *
94- * @details Called after a new account is created. This code enforces resource-limits rules
92+ * New account action, called after a new account is created. This code enforces resource-limits rules
9593 * for new accounts as well as new account naming conventions.
9694 *
9795 * 1. accounts cannot contain '.' symbols which forces all acccounts to be 12
@@ -108,9 +106,7 @@ namespace eosiobios {
108106 ignore<authority> owner,
109107 ignore<authority> active){}
110108 /* *
111- * Update authorization action.
112- *
113- * @details Updates pemission for an account.
109+ * Update authorization action updates pemission for an account.
114110 *
115111 * @param account - the account for which the permission is updated,
116112 * @param pemission - the permission name which is updated,
@@ -124,9 +120,7 @@ namespace eosiobios {
124120 ignore<authority> auth ) {}
125121
126122 /* *
127- * Delete authorization action.
128- *
129- * @details Deletes the authorization for an account's permision.
123+ * Delete authorization action deletes the authorization for an account's permission.
130124 *
131125 * @param account - the account for which the permission authorization is deleted,
132126 * @param permission - the permission name been deleted.
@@ -136,9 +130,7 @@ namespace eosiobios {
136130 ignore<name> permission ) {}
137131
138132 /* *
139- * Link authorization action.
140- *
141- * @details Assigns a specific action from a contract to a permission you have created. Five system
133+ * Link authorization action assigns a specific action from a contract to a permission you have created. Five system
142134 * actions can not be linked `updateauth`, `deleteauth`, `linkauth`, `unlinkauth`, and `canceldelay`.
143135 * This is useful because when doing authorization checks, the EOSIO based blockchain starts with the
144136 * action needed to be authorized (and the contract belonging to), and looks up which permission
@@ -159,9 +151,7 @@ namespace eosiobios {
159151 ignore<name> requirement ) {}
160152
161153 /* *
162- * Unlink authorization action.
163- *
164- * @details It's doing the reverse of linkauth action, by unlinking the given action.
154+ * Unlink authorization action it's doing the reverse of linkauth action, by unlinking the given action.
165155 *
166156 * @param account - the owner of the permission to be unlinked and the receiver of the freed RAM,
167157 * @param code - the owner of the action to be unlinked,
@@ -173,9 +163,7 @@ namespace eosiobios {
173163 ignore<name> type ) {}
174164
175165 /* *
176- * Cancel delay action.
177- *
178- * @details Cancels a deferred transaction.
166+ * Cancel delay action cancels a deferred transaction.
179167 *
180168 * @param canceling_auth - the permission that authorizes this action,
181169 * @param trx_id - the deferred transaction id to be cancelled.
@@ -184,9 +172,7 @@ namespace eosiobios {
184172 void canceldelay ( ignore<permission_level> canceling_auth, ignore<checksum256> trx_id ) {}
185173
186174 /* *
187- * Set code action.
188- *
189- * @details Sets the contract code for an account.
175+ * Set code action sets the contract code for an account.
190176 *
191177 * @param account - the account for which to set the contract code.
192178 * @param vmtype - reserved, set it to zero.
@@ -199,9 +185,7 @@ namespace eosiobios {
199185 /* * @}*/
200186
201187 /* *
202- * Set abi for contract.
203- *
204- * @details Set the abi for contract identified by `account` name. Creates an entry in the abi_hash_table
188+ * Set abi action sets the abi for contract identified by `account` name. Creates an entry in the abi_hash_table
205189 * index, with `account` name as key, if it is not already present and sets its value with the abi hash.
206190 * Otherwise it is updating the current abi hash value for the existing `account` key.
207191 *
@@ -212,9 +196,7 @@ namespace eosiobios {
212196 void setabi ( name account, const std::vector<char >& abi );
213197
214198 /* *
215- * On error action.
216- *
217- * @details Notification of this action is delivered to the sender of a deferred transaction
199+ * On error action, notification of this action is delivered to the sender of a deferred transaction
218200 * when an objective error occurs while executing the deferred transaction.
219201 * This action is not meant to be called directly.
220202 *
@@ -225,19 +207,15 @@ namespace eosiobios {
225207 void onerror ( ignore<uint128_t > sender_id, ignore<std::vector<char >> sent_trx );
226208
227209 /* *
228- * Set privilege status for an account.
229- *
230- * @details Allows to set privilege status for an account (turn it on/off).
210+ * Set privilege action allows to set privilege status for an account (turn it on/off).
231211 * @param account - the account to set the privileged status for.
232212 * @param is_priv - 0 for false, > 0 for true.
233213 */
234214 [[eosio::action]]
235215 void setpriv ( name account, uint8_t is_priv );
236216
237217 /* *
238- * Set the resource limits of an account
239- *
240- * @details Set the resource limits of an account
218+ * Sets the resource limits of an account
241219 *
242220 * @param account - name of the account whose resource limit to be set
243221 * @param ram_bytes - ram limit in absolute bytes
@@ -248,9 +226,7 @@ namespace eosiobios {
248226 void setalimits ( name account, int64_t ram_bytes, int64_t net_weight, int64_t cpu_weight );
249227
250228 /* *
251- * Set a new list of active producers, that is, a new producers' schedule.
252- *
253- * @details Set a new list of active producers, by proposing a schedule change, once the block that
229+ * Set producers action, sets a new list of active producers, by proposing a schedule change, once the block that
254230 * contains the proposal becomes irreversible, the schedule is promoted to "pending"
255231 * automatically. Once the block that promotes the schedule is irreversible, the schedule will
256232 * become "active".
@@ -261,19 +237,15 @@ namespace eosiobios {
261237 void setprods ( const std::vector<eosio::producer_authority>& schedule );
262238
263239 /* *
264- * Set the blockchain parameters
265- *
266- * @details Set the blockchain parameters. By tuning these parameters, various degrees of customization can be achieved.
240+ * Set params action, sets the blockchain parameters. By tuning these parameters, various degrees of customization can be achieved.
267241 *
268242 * @param params - New blockchain parameters to set
269243 */
270244 [[eosio::action]]
271245 void setparams ( const eosio::blockchain_parameters& params );
272246
273247 /* *
274- * Check if an account has authorization to access current action.
275- *
276- * @details Checks if the account name `from` passed in as param has authorization to access
248+ * Require authorization action, checks if the account name `from` passed in as param has authorization to access
277249 * current action, that is, if it is listed in the action’s allowed permissions vector.
278250 *
279251 * @param from - the account name to authorize
@@ -282,19 +254,15 @@ namespace eosiobios {
282254 void reqauth ( name from );
283255
284256 /* *
285- * Activates a protocol feature.
286- *
287- * @details Activates a protocol feature
257+ * Activate action, activates a protocol feature
288258 *
289259 * @param feature_digest - hash of the protocol feature to activate.
290260 */
291261 [[eosio::action]]
292262 void activate ( const eosio::checksum256& feature_digest );
293263
294264 /* *
295- * Asserts that a protocol feature has been activated.
296- *
297- * @details Asserts that a protocol feature has been activated
265+ * Require activated action, asserts that a protocol feature has been activated
298266 *
299267 * @param feature_digest - hash of the protocol feature to check for activation.
300268 */
0 commit comments