| Minos Galanakis | f4ca6ac | 2017-12-11 02:39:21 +0100 | [diff] [blame^] | 1 | #------------------------------------------------------------------------------- |
| 2 | # Copyright (c) 2017-2019, Arm Limited and Contributors. All rights reserved. |
| 3 | # |
| 4 | # SPDX-License-Identifier: BSD-3-Clause |
| 5 | # |
| 6 | #------------------------------------------------------------------------------- |
| 7 | |
| 8 | ## |
| 9 | ##@file |
| 10 | ##@brief Shell documentation examples |
| 11 | ## |
| 12 | |
| 13 | |
| 14 | ##@var string example_variable |
| 15 | ##@brief Example variable |
| 16 | ## |
| 17 | ##This is an example to show ho to document variables. |
| 18 | ## |
| 19 | #This is needed for doxygen for now. |
| 20 | #!string example_variable; |
| 21 | |
| 22 | |
| 23 | ##@fn example_function(path build_base_dir, string build_config_name) |
| 24 | ##@brief En example function. |
| 25 | ##@param[in] build_base_dir |
| 26 | ##@param[in] build_config_name |
| 27 | ##@returns N/A |
| 28 | ## |
| 29 | ##This function was only made to show how-to document a function. |
| 30 | ## |
| 31 | ##Usage: |
| 32 | ## command | result |
| 33 | ## --------|------- |
| 34 | ## example_function "test_build_st32" "somestring" | Do whatever is done. |
| 35 | ## |
| 36 | #This is needed for doxygen for now. |
| 37 | #!void example_function(path build_base_dir, string build_config_name){}; |
| 38 | # |
| 39 | |