|
| 1 | +# SDK version. |
| 2 | +PROJECT_NUMBER = "3" |
| 3 | + |
| 4 | +# Doxygen layout file for libraries. |
| 5 | +LAYOUT_FILE = doc/config/layout_library.xml |
| 6 | + |
| 7 | +# Documentation output directory. |
| 8 | +OUTPUT_DIRECTORY = doc/output/ |
| 9 | + |
| 10 | +# Don't generate LaTeX documentation |
| 11 | +GENERATE_LATEX = NO |
| 12 | + |
| 13 | +# Don't rearrange members in the input files. |
| 14 | +SORT_MEMBER_DOCS = NO |
| 15 | + |
| 16 | +# Silence output (warnings only). |
| 17 | +QUIET = YES |
| 18 | + |
| 19 | +# Configure Doxygen for C. |
| 20 | +OPTIMIZE_OUTPUT_FOR_C = YES |
| 21 | +TYPEDEF_HIDES_STRUCT = YES |
| 22 | + |
| 23 | +# Disable the tab bar and use treeview instead. |
| 24 | +DISABLE_INDEX = YES |
| 25 | +GENERATE_TREEVIEW = YES |
| 26 | + |
| 27 | +# All files should have unique names, so showing the full path is unnecessary. |
| 28 | +FULL_PATH_NAMES = NO |
| 29 | + |
| 30 | +# Disable the default Doxygen diagrams. |
| 31 | +HAVE_DOT = NO |
| 32 | + |
| 33 | +# Disable the default Doxygen search engine (for now). |
| 34 | +SEARCHENGINE = NO |
| 35 | + |
| 36 | +# Use custom header file, footer file, and stylesheet. |
| 37 | +HTML_HEADER = doc/config/html/header.html |
| 38 | +HTML_FOOTER = doc/config/html/footer.html |
| 39 | +HTML_EXTRA_STYLESHEET = doc/config/html/style.css |
| 40 | + |
| 41 | +# Don't show external pages or groups. |
| 42 | +EXTERNAL_GROUPS = NO |
| 43 | +EXTERNAL_PAGES = NO |
| 44 | + |
| 45 | +# Preprocessor defines. |
| 46 | +PREDEFINED = _ENABLE_THREAD_SUPPORT_ |
| 47 | + |
| 48 | +# Alias for starting a dependencies section. |
| 49 | +ALIASES += dependencies{2}="@section \1_dependencies Dependencies^^@brief Dependencies of the \2.^^^^" |
| 50 | + |
| 51 | +# Alias for starting a configuration settings page. |
| 52 | +ALIASES += describeconfig="Configuration settings are C pre-processor constants. They can be set with a @c #`define` in the config file (`iot_config.h`) or by using a compiler option such as `-D` in gcc. If a configuration setting is not defined, the library will use a \"sensible\" default value (unless otherwise noted). Because they are compile-time constants, a library must be rebuilt if a configuration setting is changed." |
| 53 | +ALIASES += configpage{2}="@page \1_config Configuration^^@brief Configuration settings of the \2.^^^^@describeconfig^^@par configpagemarker" |
| 54 | +ALIASES += configpage{4}="@page \1_config \3 Configuration^^@brief Configuration settings of the \2.^^^^@describeconfig^^^^The settings on this page only affect the [\2](@ref \1). In addition to the settings on this page, them \2 will also be affected by [settings that affect all \4](@ref global_\4_config).^^@par configpagemarker" |
| 55 | +ALIASES += globalconfigpage{3}="@page global_\1_config Global \2 Configuration^^^^@describeconfig^^@brief Configuration settings that affect all \3.^^@par configpagemarker" |
| 56 | + |
| 57 | +# Aliases for "Possible values", "Recommended values", and "Default values" |
| 58 | +# used in configuration setting pages. |
| 59 | +ALIASES += configpossible="<b>Possible values:</b> " |
| 60 | +ALIASES += configrecommended="<b>Recommended values:</b> " |
| 61 | +ALIASES += configdefault="<b>Default value (if undefined):</b> " |
| 62 | + |
| 63 | +# Alias for starting a constants page. |
| 64 | +ALIASES += constantspage{2}="@page \1_constants Constants^^@brief Defined constants of the \2.^^^^Libraries may @c #`define` constants in their headers with special meanings. This page describes the meanings and uses of any constants defined by the \2. Related constants are shown in a single section on this page.^^" |
| 65 | + |
| 66 | +# Alias for starting a functions page. |
| 67 | +ALIASES += functionspage{2}="@page \1_functions Functions^^@brief Functions of the \2.^^^^The \2 consists of the following functions." |
| 68 | +ALIASES += functionspage{3}="@page \1_functions \3^^@brief Functions of the \2.^^^^The \2 consists of the following functions." |
| 69 | + |
| 70 | +# Alias for listing a single function on a functions page. |
| 71 | +ALIASES += functionname{1}="@subpage \1 <br>^^ @copybrief \1^^" |
| 72 | + |
| 73 | +# Alias for creating a page for a single function. |
| 74 | +ALIASES += functionpage{3}="@page \2_function_\3 \1^^^^@snippet this declare_\2_\3^^@copydoc \1" |
| 75 | + |
| 76 | +# Alias for starting a handles group. |
| 77 | +ALIASES += handles{2}="@defgroup \1_datatypes_handles Handles^^@brief Opaque handles of the \2." |
| 78 | + |
| 79 | +# Alias for starting an enum group. |
| 80 | +ALIASES += enums{2}="@defgroup \1_datatypes_enums Enumerated types^^@brief Enumerated types of the \2." |
| 81 | + |
| 82 | +# Alias for starting a function pointers group. |
| 83 | +ALIASES += functionpointers{2}="@defgroup \1_datatypes_functionpointers Function pointers types^^@brief Function pointers types of the \2." |
| 84 | + |
| 85 | +# Alias for starting a structs group. |
| 86 | +ALIASES += structs{2}="@defgroup \1_datatypes_structs Structured types^^@brief Structured types of the \2." |
| 87 | + |
| 88 | +# Alias for starting a parameter structures group. |
| 89 | +ALIASES += paramstructs{2}="@defgroup \1_datatypes_paramstructs Parameter structures^^@brief Structures passed as parameters to [\2 functions](@ref \1_functions)^^^^These structures are passed as parameters to library functions. Documentation for these structures will state the functions associated with each parameter structure and the purpose of each member." |
| 90 | + |
| 91 | +# Alias for "Parameter for". |
| 92 | +ALIASES += paramfor="<b>Parameter for:</b> " |
| 93 | + |
| 94 | +# Alias for parameter structure initializers. |
| 95 | +ALIASES += initializer{2}="All instances of #\1 should be initialized with #\2.^^" |
0 commit comments