From 6ed5f2d736f8829e8d1a711c93f4fd14b936c1f8 Mon Sep 17 00:00:00 2001 From: Luis Date: Mon, 27 Mar 2023 15:36:35 -0400 Subject: [PATCH 1/5] fix license broken link :doc --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 289ae23de2..17d72f32fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,4 +10,4 @@ If you are upgrading to CDT version 3.0 or later from version 1.8.1 (or earlier) ## License -[MIT](../LICENSE) +[MIT](https://github.com/AntelopeIO/cdt/blob/release/3.0/LICENSE) From 1e41e1ebf07f269d4fee17e3d965bd77f2d1bc41 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 30 Mar 2023 12:57:42 -0400 Subject: [PATCH 2/5] fix broken links to lib references in how-tos --- .../how_to_restrict_access_to_an_action_by_user.md | 10 +++++----- .../how-to-define-a-primary-index.md | 4 ++-- .../how-to-define-a-secondary-index.md | 4 ++-- .../40_multi-index/how-to-define-a-singleton.md | 4 ++-- .../how-to-delete-data-from-a-multi-index-table.md | 14 +++++++------- .../how-to-insert-data-into-a-multi-index-table.md | 10 +++++----- .../how-to-instantiate-a-multi-index-table.md | 4 ++-- ...a-multi_index-table-based-on-secondary-index.md | 6 +++--- ...-to-iterate-and-retrieve-a-multi_index-table.md | 6 +++--- .../how-to-modify-data-in-a-multi-index-table.md | 12 ++++++------ .../50_how-to-create-and-use-action-wrappers.md | 4 ++-- .../60_how-to-return-values-from-actions.md | 2 +- 12 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md b/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md index dc664aa32c..a88c1daf04 100644 --- a/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md +++ b/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md @@ -16,10 +16,10 @@ This guide provides instructions how to perform authorization checks in a smart See the following code reference guides for functions which can be used to implement authorization checks in a smart contract: -* function [has_auth(name n)](http://docs.eosnetwork.com/cdt/latest/reference/Namespaces/namespaceeosio#function-has_auth) -* function [require_auth(name n)](http://docs.eosnetwork.com/cdt/latest/reference/Namespaces/namespaceeosio#function-require_auth) -* function [require_auth2(capi_name name, capi_name permission)](http://docs.eosnetwork.com/cdt/latest/reference/Files/action_8h) -* function [check(bool pred, ...)](http://docs.eosnetwork.com/cdt/latest/reference/Namespaces/namespaceeosio#function-check) +* function [has_auth(name n)](/reference/Namespaces/namespaceeosio#function-has_auth) +* function [require_auth(name n)](/reference/Namespaces/namespaceeosio#function-require_auth) +* function [require_auth2(capi_name name, capi_name permission)](/reference/Files/action_8h) +* function [check(bool pred, ...)](/reference/Namespaces/namespaceeosio#function-check) ## Procedure @@ -45,7 +45,7 @@ void hi( name user ) { } ``` -Another example can be found in the [Tic Tac Toe Tutorial](https://docs.eosnetwork.com/docs/latest/tutorials/tic-tac-toe-game-contract#action-handler---move). +Another example can be found in the [Tic Tac Toe Tutorial](https://docs.eosnetwork.com/docs/latest/smart-contracts/tutorials/tic-tac-toe-game-contract#create-tictactoecpp-file). ### 2. Use require_auth diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md index 1fafa82d85..f3f5390924 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md @@ -10,13 +10,13 @@ This guide provides instructions to define a primary index for a multi-index tab See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md index 6097bc17a2..216989897f 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md @@ -10,13 +10,13 @@ This guide provides instructions to define a secondary index for a multi-index t See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index table `testtab` along with its `test_table` data structure, its mandatory primary index, and the type alias definition `test_table_t`. Please see [How To Define A Primary Index](./how-to-define-a-primary-index) to set up these prerequisites. ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md index fe870cea15..1b7b2b71ae 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md @@ -10,13 +10,13 @@ This guide provides instructions to define a singleton. See the following code reference: -* The [`singleton`](../../classeosio_1_1singleton) class. +* The [`singleton`](/reference/Classes/classeosio_1_1singleton) class. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md index e6971f581a..e652eedaf3 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md @@ -10,15 +10,15 @@ This guide provides instructions to to delete data from a multi-index table. See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](../../group__multiindex#function-find) method. -* The [`multi-index::erase(...)`](../../group__multiindex/#function-erase) method. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. +* The [`multi-index::erase(...)`](/reference/Modules/group__multiindex#function-erase) method. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index `testab` table instance which stores `user` objects indexed by the primary key which is of type `eosio::name`. Consult the section [How to instantiate a multi-index table](./how-to-instantiate-a-multi-index-table.md) to learn how to set it up. ## Procedure @@ -27,7 +27,7 @@ Complete the following steps to implement a `del` action which deletes an user o ### 1. Find The User You Want To Delete -Use the multi-index [`find(...)`](../../group__multiindex#function-find) method to locate the user object you want to delete. The targeted user is searched based on its account name. +Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function-find) method to locate the user object you want to delete. The targeted user is searched based on its account name. ```cpp [[eosio::action]] void multi_index_example::del( name user ) { @@ -38,7 +38,7 @@ Use the multi-index [`find(...)`](../../group__multiindex#function-find) method ### 2. Delete The User If Found -Check to see if the user exists and use [`erase`(...)](../../group__multiindex/#function-erase) method to delete the row from table. Otherwise print an informational message and return. +Check to see if the user exists and use [`erase`(...)](/reference/Modules/group__multiindex#function-erase) method to delete the row from table. Otherwise print an informational message and return. ```diff [[eosio::action]] void multi_index_example::del( name user ) { @@ -62,7 +62,7 @@ In conclusion, the above instructions show how to delete data from a multi-index ## Next Steps -* You can verify if the user object was deleted from the multi-index table. . +* You can verify if the user object was deleted from the multi-index table. ```cpp // check if the user was deleted diff --git a/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md index d0c7aca92b..d064c9aa44 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md @@ -10,15 +10,15 @@ This guide provides instructions to insert data into a multi-index table. See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](../../group__multiindex#function-find) method. -* The [`multi-index::emplace(...)`](../../group__multiindex/#function-emplace) method. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. +* The [`multi-index::emplace(...)`](/reference/Modules/group__multiindex#function-emplace) method. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index `testab` table instance which stores `user` objects indexed by the primary key which is of type `eosio::name`. Consult the section [How to instantiate a multi-index table](./how-to-instantiate-a-multi-index-table.md) to learn how to set it up. ## Procedure @@ -38,7 +38,7 @@ Use of the multi-index table iterator to find out if the user object already exi ### 2. Insert The User If Not Found In Table -Use the [`emplace`](../../group__multiindex/#function-emplace) method to make the insertion if the user object is not already in the multi-index table. Otherwise print an informational message. +Use the [`emplace`](/reference/Modules/group__multiindex#function-emplace) method to make the insertion if the user object is not already in the multi-index table. Otherwise print an informational message. ```diff [[eosio::action]] void multi_index_example::set( name user ) { diff --git a/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md index 3f23ef1b89..d6606bcf75 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md @@ -10,13 +10,13 @@ This guide provides instructions to instantiate a multi-index table. See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md index 315bdfd2a0..7ab89b2ea2 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md @@ -10,14 +10,14 @@ This guide provides instructions on how iterate and retrieve data from a multi-i See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](../../group__multiindex#function-find) method. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index `testab` table instance which stores `user` objects indexed by the primary key which is of type `eosio::name` and a secondary index for data member `secondary` of type `eosio::name` accessible through `by_secondary()` method. Consult the section [How to define a secondary index](./how-to-define-a-secondary-index) to learn how to set it up. ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md index a38f76c8b1..9314dfe9d3 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md @@ -10,14 +10,14 @@ This guide provides instructions to iterate and retrieve data from a multi-index See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](../../group__multiindex#function-find) method. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index `testab` table instance which stores `user` objects indexed by the primary key which is of type `eosio::name`. Consult the section [How to instantiate a multi-index table](./how-to-instantiate-a-multi-index-table) to learn how to set it up. ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md index 1a87c297c2..05e5764230 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md @@ -10,14 +10,14 @@ This guide provides instructions to modify data in a multi-index table. See the following code reference: -* The [`multi-index`](../../classeosio_1_1multi__index) class. -* The [`multi-index::modify(...)`](../../group__multiindex/#function-modify) method. +* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::modify(...)`](/reference/Modules/group__multiindex#function-modify) method. ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/), +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A multi-index `testab` table instance which stores `user` objects indexed by the primary key which is of type `eosio::name`. Consult the section [How to instantiate a multi-index table](./how-to-instantiate-a-multi-index-table) to learn how to set it up. ## Procedure @@ -42,7 +42,7 @@ Optionally, for ease of use add the action wrapper definition as well. ### 2. Find The User You Want To Modify -Use the multi-index [`find(...)`](../../group__multiindex#function-find) method to locate the user object you want to modify. The targeted user is searched based on its account name. +Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function-find) method to locate the user object you want to modify. The targeted user is searched based on its account name. ```cpp [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { @@ -52,7 +52,7 @@ Use the multi-index [`find(...)`](../../group__multiindex#function-find) method ### 3. Yield Error If User Not Found -If the `user` object you want to update is not found then raise an error message by using the [`eosio::check`](../../namespaceeosio/#function-check-17) method. +If the `user` object you want to update is not found then raise an error message by using the [`eosio::check`](/reference/Namespaces/namespaceeosio#function-check) method. ```diff [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { @@ -63,7 +63,7 @@ If the `user` object you want to update is not found then raise an error message ### 4. Update The User If Found -If the `user` object you want to update is found, the [`eosio::check`](../../namespaceeosio/#function-check-17) method will do nothing and the iterator `itr` will be pointing at the object which you want to update. Use the [`multi-index::modify(...)`](../../group__multiindex/#function-modify) method to update the user object `datum` data member with the `value` parameter. +If the `user` object you want to update is found, the [`eosio::check`](/reference/Namespaces/namespaceeosio#function-check) method will do nothing and the iterator `itr` will be pointing at the object which you want to update. Use the [`multi-index::modify(...)`](/reference/Modules/group__multiindex#function-modify) method to update the user object `datum` data member with the `value` parameter. ```diff [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { diff --git a/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md b/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md index 0aff9276fa..6125ae1dfe 100644 --- a/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md +++ b/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md @@ -11,13 +11,13 @@ This guide provides instructions to create and use an action wrapper in a smart See the following code reference guide for action wrapper: -* [eosio::action_wrapper](../structeosio_1_1action__wrapper). +* [eosio::action_wrapper](/reference/Classes/structeosio_1_1action__wrapper). ## Before you begin Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/). +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A smart contract named `multi_index_example`, defined in file `multi_index_example.hpp`. * An action `mod` which modifies the integer value `n` stored for row with key `user`. diff --git a/docs/06_how-to-guides/60_how-to-return-values-from-actions.md b/docs/06_how-to-guides/60_how-to-return-values-from-actions.md index dd953eaa49..3f1266a886 100644 --- a/docs/06_how-to-guides/60_how-to-return-values-from-actions.md +++ b/docs/06_how-to-guides/60_how-to-return-values-from-actions.md @@ -12,7 +12,7 @@ In order to accomplish this, use the `return` statement and pass the desired ret Make sure you have the following prerequisites in place: -* An Antelope development environment, for details consult the [Get Started Guide](https://docs.eosnetwork.com/docs/latest/getting-started/). +* An Antelope development environment, for details consult the [Documentation Portal](https://docs.eosnetwork.com/docs/latest/). * A smart contract, let’s call it `smrtcontract`, which builds without error. * An action, let’s call it `checkwithrv`, from which you want to return a value of a user defined type `action_response`. From 94f51c8fd42879562a996104064cb6a899350825 Mon Sep 17 00:00:00 2001 From: Luis Date: Fri, 31 Mar 2023 00:31:34 -0400 Subject: [PATCH 3/5] make lib references relative in how-tos --- .../how_to_restrict_access_to_an_action_by_user.md | 8 ++++---- .../40_multi-index/how-to-define-a-primary-index.md | 2 +- .../40_multi-index/how-to-define-a-secondary-index.md | 2 +- .../40_multi-index/how-to-define-a-singleton.md | 2 +- .../how-to-delete-data-from-a-multi-index-table.md | 10 +++++----- .../how-to-insert-data-into-a-multi-index-table.md | 8 ++++---- .../how-to-instantiate-a-multi-index-table.md | 2 +- ...eve-a-multi_index-table-based-on-secondary-index.md | 4 ++-- .../how-to-iterate-and-retrieve-a-multi_index-table.md | 4 ++-- .../how-to-modify-data-in-a-multi-index-table.md | 10 +++++----- .../50_how-to-create-and-use-action-wrappers.md | 2 +- 11 files changed, 27 insertions(+), 27 deletions(-) diff --git a/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md b/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md index a88c1daf04..04269f4b4d 100644 --- a/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md +++ b/docs/06_how-to-guides/20_authorization/how_to_restrict_access_to_an_action_by_user.md @@ -16,10 +16,10 @@ This guide provides instructions how to perform authorization checks in a smart See the following code reference guides for functions which can be used to implement authorization checks in a smart contract: -* function [has_auth(name n)](/reference/Namespaces/namespaceeosio#function-has_auth) -* function [require_auth(name n)](/reference/Namespaces/namespaceeosio#function-require_auth) -* function [require_auth2(capi_name name, capi_name permission)](/reference/Files/action_8h) -* function [check(bool pred, ...)](/reference/Namespaces/namespaceeosio#function-check) +* function [has_auth(name n)](../../reference/Namespaces/namespaceeosio#function-has_auth) +* function [require_auth(name n)](../../reference/Namespaces/namespaceeosio#function-require_auth) +* function [require_auth2(capi_name name, capi_name permission)](../../reference/Files/action_8h) +* function [check(bool pred, ...)](../../reference/Namespaces/namespaceeosio#function-check) ## Procedure diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md index f3f5390924..a8497d0521 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-primary-index.md @@ -10,7 +10,7 @@ This guide provides instructions to define a primary index for a multi-index tab See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md index 216989897f..b689f52a25 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-secondary-index.md @@ -10,7 +10,7 @@ This guide provides instructions to define a secondary index for a multi-index t See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md b/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md index 1b7b2b71ae..b46d08cfd4 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-define-a-singleton.md @@ -10,7 +10,7 @@ This guide provides instructions to define a singleton. See the following code reference: -* The [`singleton`](/reference/Classes/classeosio_1_1singleton) class. +* The [`singleton`](../../reference/Classes/classeosio_1_1singleton) class. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md index e652eedaf3..5e8d0ab644 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-delete-data-from-a-multi-index-table.md @@ -10,9 +10,9 @@ This guide provides instructions to to delete data from a multi-index table. See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. -* The [`multi-index::erase(...)`](/reference/Modules/group__multiindex#function-erase) method. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](../../reference/Modules/group__multiindex#function-find) method. +* The [`multi-index::erase(...)`](../../reference/Modules/group__multiindex#function-erase) method. ## Before you begin @@ -27,7 +27,7 @@ Complete the following steps to implement a `del` action which deletes an user o ### 1. Find The User You Want To Delete -Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function-find) method to locate the user object you want to delete. The targeted user is searched based on its account name. +Use the multi-index [`find(...)`](../../reference/Modules/group__multiindex#function-find) method to locate the user object you want to delete. The targeted user is searched based on its account name. ```cpp [[eosio::action]] void multi_index_example::del( name user ) { @@ -38,7 +38,7 @@ Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function- ### 2. Delete The User If Found -Check to see if the user exists and use [`erase`(...)](/reference/Modules/group__multiindex#function-erase) method to delete the row from table. Otherwise print an informational message and return. +Check to see if the user exists and use [`erase`(...)](../../reference/Modules/group__multiindex#function-erase) method to delete the row from table. Otherwise print an informational message and return. ```diff [[eosio::action]] void multi_index_example::del( name user ) { diff --git a/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md index d064c9aa44..75427f56cf 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-insert-data-into-a-multi-index-table.md @@ -10,9 +10,9 @@ This guide provides instructions to insert data into a multi-index table. See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. -* The [`multi-index::emplace(...)`](/reference/Modules/group__multiindex#function-emplace) method. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](../../reference/Modules/group__multiindex#function-find) method. +* The [`multi-index::emplace(...)`](../../reference/Modules/group__multiindex#function-emplace) method. ## Before you begin @@ -38,7 +38,7 @@ Use of the multi-index table iterator to find out if the user object already exi ### 2. Insert The User If Not Found In Table -Use the [`emplace`](/reference/Modules/group__multiindex#function-emplace) method to make the insertion if the user object is not already in the multi-index table. Otherwise print an informational message. +Use the [`emplace`](../../reference/Modules/group__multiindex#function-emplace) method to make the insertion if the user object is not already in the multi-index table. Otherwise print an informational message. ```diff [[eosio::action]] void multi_index_example::set( name user ) { diff --git a/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md index d6606bcf75..0a15ad44ee 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-instantiate-a-multi-index-table.md @@ -10,7 +10,7 @@ This guide provides instructions to instantiate a multi-index table. See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md index 7ab89b2ea2..9d0025896b 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table-based-on-secondary-index.md @@ -10,8 +10,8 @@ This guide provides instructions on how iterate and retrieve data from a multi-i See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](../../reference/Modules/group__multiindex#function-find) method. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md index 9314dfe9d3..7451c0f646 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-iterate-and-retrieve-a-multi_index-table.md @@ -10,8 +10,8 @@ This guide provides instructions to iterate and retrieve data from a multi-index See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. -* The [`multi-index::find(...)`](/reference/Modules/group__multiindex#function-find) method. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::find(...)`](../../reference/Modules/group__multiindex#function-find) method. ## Before you begin diff --git a/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md b/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md index 05e5764230..eee7e86040 100644 --- a/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md +++ b/docs/06_how-to-guides/40_multi-index/how-to-modify-data-in-a-multi-index-table.md @@ -10,8 +10,8 @@ This guide provides instructions to modify data in a multi-index table. See the following code reference: -* The [`multi-index`](/reference/Classes/classeosio_1_1multi__index) class. -* The [`multi-index::modify(...)`](/reference/Modules/group__multiindex#function-modify) method. +* The [`multi-index`](../../reference/Classes/classeosio_1_1multi__index) class. +* The [`multi-index::modify(...)`](../../reference/Modules/group__multiindex#function-modify) method. ## Before you begin @@ -42,7 +42,7 @@ Optionally, for ease of use add the action wrapper definition as well. ### 2. Find The User You Want To Modify -Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function-find) method to locate the user object you want to modify. The targeted user is searched based on its account name. +Use the multi-index [`find(...)`](../../reference/Modules/group__multiindex#function-find) method to locate the user object you want to modify. The targeted user is searched based on its account name. ```cpp [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { @@ -52,7 +52,7 @@ Use the multi-index [`find(...)`](/reference/Modules/group__multiindex#function- ### 3. Yield Error If User Not Found -If the `user` object you want to update is not found then raise an error message by using the [`eosio::check`](/reference/Namespaces/namespaceeosio#function-check) method. +If the `user` object you want to update is not found then raise an error message by using the [`eosio::check`](../../reference/Namespaces/namespaceeosio#function-check) method. ```diff [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { @@ -63,7 +63,7 @@ If the `user` object you want to update is not found then raise an error message ### 4. Update The User If Found -If the `user` object you want to update is found, the [`eosio::check`](/reference/Namespaces/namespaceeosio#function-check) method will do nothing and the iterator `itr` will be pointing at the object which you want to update. Use the [`multi-index::modify(...)`](/reference/Modules/group__multiindex#function-modify) method to update the user object `datum` data member with the `value` parameter. +If the `user` object you want to update is found, the [`eosio::check`](../../reference/Namespaces/namespaceeosio#function-check) method will do nothing and the iterator `itr` will be pointing at the object which you want to update. Use the [`multi-index::modify(...)`](../../reference/Modules/group__multiindex#function-modify) method to update the user object `datum` data member with the `value` parameter. ```diff [[eosio::action]] void multi_index_example::mod( name user, uint32_t value ) { diff --git a/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md b/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md index 6125ae1dfe..9ecac19b06 100644 --- a/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md +++ b/docs/06_how-to-guides/50_how-to-create-and-use-action-wrappers.md @@ -11,7 +11,7 @@ This guide provides instructions to create and use an action wrapper in a smart See the following code reference guide for action wrapper: -* [eosio::action_wrapper](/reference/Classes/structeosio_1_1action__wrapper). +* [eosio::action_wrapper](../reference/Classes/structeosio_1_1action__wrapper). ## Before you begin From cf40868748de65b56eb80a10a7307368cc281659 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 6 Apr 2023 11:05:58 -0400 Subject: [PATCH 4/5] fix url to license file 3.0 to 3.1 :doc --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 17d72f32fd..349fb878fd 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,4 +10,4 @@ If you are upgrading to CDT version 3.0 or later from version 1.8.1 (or earlier) ## License -[MIT](https://github.com/AntelopeIO/cdt/blob/release/3.0/LICENSE) +[MIT](https://github.com/AntelopeIO/cdt/blob/release/3.1/LICENSE) From 262b0f487565cca9ace18367c12a5a2ec3253ef0 Mon Sep 17 00:00:00 2001 From: Luis Date: Thu, 6 Apr 2023 12:11:03 -0400 Subject: [PATCH 5/5] fix url to license file 3.1 to main :doc --- docs/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/index.md b/docs/index.md index 349fb878fd..0015bdfab8 100644 --- a/docs/index.md +++ b/docs/index.md @@ -10,4 +10,4 @@ If you are upgrading to CDT version 3.0 or later from version 1.8.1 (or earlier) ## License -[MIT](https://github.com/AntelopeIO/cdt/blob/release/3.1/LICENSE) +[MIT](https://github.com/AntelopeIO/cdt/blob/main/LICENSE)