Skip to content

Commit d176b6b

Browse files
tokangasnordicjm
authored andcommitted
lib: lte_link_control: Remove Kconfig links from library header
Removed Kconfig links from the library header. The reason behind the change is that Breathe is no longer used when generating the documentation, and without Breathe the links do not work and only cause the generated documentation to look bad. Signed-off-by: Tommi Kangas <[email protected]>
1 parent cd87f3b commit d176b6b

File tree

1 file changed

+30
-30
lines changed

1 file changed

+30
-30
lines changed

include/modem/lte_lc.h

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -961,7 +961,7 @@ struct lte_lc_conn_eval_params {
961961
*
962962
* When using search types up to @ref LTE_LC_NEIGHBOR_SEARCH_TYPE_EXTENDED_COMPLETE, the result
963963
* contains parameters from current/serving cell and optionally up to
964-
* @kconfig{CONFIG_LTE_NEIGHBOR_CELLS_MAX} neighbor cells.
964+
* `CONFIG_LTE_NEIGHBOR_CELLS_MAX` neighbor cells.
965965
*
966966
* Result notification for Global Cell ID (GCI) search types include Cell ID, PLMN and TAC for up to
967967
* @c gci_count (@ref lte_lc_ncellmeas_params) surrounding cells.
@@ -1373,7 +1373,7 @@ int lte_lc_normal(void);
13731373
* For encoding of the variables, see nRF AT Commands Reference Guide, 3GPP 27.007 Ch. 7.38., and
13741374
* 3GPP 24.008 Ch. 10.5.7.4a and Ch. 10.5.7.3.
13751375
*
1376-
* @note Requires @kconfig{CONFIG_LTE_LC_PSM_MODULE} to be enabled.
1376+
* @note Requires `CONFIG_LTE_LC_PSM_MODULE` to be enabled.
13771377
*
13781378
* @param[in] rptau
13791379
* @parblock
@@ -1435,7 +1435,7 @@ int lte_lc_psm_param_set(const char *rptau, const char *rat);
14351435
* For more information about the encodings, see the description of the
14361436
* lte_lc_psm_param_set() function.
14371437
*
1438-
* @note Requires @kconfig{CONFIG_LTE_LC_PSM_MODULE} to be enabled.
1438+
* @note Requires `CONFIG_LTE_LC_PSM_MODULE` to be enabled.
14391439
*
14401440
* @param[in] rptau
14411441
* @parblock
@@ -1468,18 +1468,18 @@ int lte_lc_psm_param_set_seconds(int rptau, int rat);
14681468
/**
14691469
* Request modem to enable or disable Power Saving Mode (PSM).
14701470
*
1471-
* PSM parameters can be set using @kconfig{CONFIG_LTE_PSM_REQ_FORMAT},
1472-
* @kconfig{CONFIG_LTE_PSM_REQ_RPTAU}, @kconfig{CONFIG_LTE_PSM_REQ_RAT},
1473-
* @kconfig{CONFIG_LTE_PSM_REQ_RPTAU_SECONDS} and @kconfig{CONFIG_LTE_PSM_REQ_RAT_SECONDS},
1471+
* PSM parameters can be set using `CONFIG_LTE_PSM_REQ_FORMAT`,
1472+
* `CONFIG_LTE_PSM_REQ_RPTAU`, `CONFIG_LTE_PSM_REQ_RAT`,
1473+
* `CONFIG_LTE_PSM_REQ_RPTAU_SECONDS` and `CONFIG_LTE_PSM_REQ_RAT_SECONDS`,
14741474
* or by calling lte_lc_psm_param_set() or lte_lc_psm_param_set_seconds().
14751475
*
1476-
* @note @kconfig{CONFIG_LTE_PSM_REQ} can be set to enable PSM, which is generally sufficient. This
1476+
* @note `CONFIG_LTE_PSM_REQ` can be set to enable PSM, which is generally sufficient. This
14771477
* option allows explicit disabling/enabling of PSM requesting after modem initialization.
14781478
* Calling this function for run-time control is possible, but it should be noted that
1479-
* conflicts may arise with the value set by @kconfig{CONFIG_LTE_PSM_REQ} if it is called
1479+
* conflicts may arise with the value set by `CONFIG_LTE_PSM_REQ` if it is called
14801480
* during modem initialization.
14811481
*
1482-
* @note Requires @kconfig{CONFIG_LTE_LC_PSM_MODULE} to be enabled.
1482+
* @note Requires `CONFIG_LTE_LC_PSM_MODULE` to be enabled.
14831483
*
14841484
* @param[in] enable @c true to enable PSM, @c false to disable PSM.
14851485
*
@@ -1491,7 +1491,7 @@ int lte_lc_psm_req(bool enable);
14911491
/**
14921492
* Get the current PSM (Power Saving Mode) configuration.
14931493
*
1494-
* @note Requires @kconfig{CONFIG_LTE_LC_PSM_MODULE} to be enabled.
1494+
* @note Requires `CONFIG_LTE_LC_PSM_MODULE` to be enabled.
14951495
*
14961496
* @param[out] tau Periodic TAU interval in seconds. A non-negative integer.
14971497
* @param[out] active_time Active time in seconds. A non-negative integer,
@@ -1513,20 +1513,20 @@ int lte_lc_psm_get(int *tau, int *active_time);
15131513
* would do if network allowed to use PSM. Sending of MO data or MO SMS will automatically wake up
15141514
* the modem just like if modem was in normal PSM sleep.
15151515
*
1516-
* To use the feature, also PSM request must be enabled using @kconfig{CONFIG_LTE_PSM_REQ} or
1516+
* To use the feature, also PSM request must be enabled using `CONFIG_LTE_PSM_REQ` or
15171517
* lte_lc_psm_req().
15181518
*
15191519
* Refer to the AT command guide for guidance and limitations of this feature.
15201520
*
1521-
* @note @kconfig{CONFIG_LTE_PROPRIETARY_PSM_REQ} can be set to enable proprietary PSM, which is
1521+
* @note `CONFIG_LTE_PROPRIETARY_PSM_REQ` can be set to enable proprietary PSM, which is
15221522
* generally sufficient. This option allows to enable or disable proprietary PSM after modem
15231523
* initialization. Calling this function for run-time control is possible, but it should be
15241524
* noted that conflicts may arise with the value set by
1525-
* @kconfig{CONFIG_LTE_PROPRIETARY_PSM_REQ} if it is called during modem initialization.
1525+
* `CONFIG_LTE_PROPRIETARY_PSM_REQ` if it is called during modem initialization.
15261526
*
15271527
* @note This feature is only supported by modem firmware versions >= v2.0.0.
15281528
*
1529-
* @note Requires @kconfig{CONFIG_LTE_LC_PSM_MODULE} to be enabled.
1529+
* @note Requires `CONFIG_LTE_LC_PSM_MODULE` to be enabled.
15301530
*
15311531
* @retval 0 if successful.
15321532
* @retval -EFAULT if AT command failed.
@@ -1544,7 +1544,7 @@ int lte_lc_proprietary_psm_req(bool enable);
15441544
*
15451545
* For reference to which values can be set, see subclause 10.5.5.32 of 3GPP TS 24.008.
15461546
*
1547-
* @note Requires @kconfig{CONFIG_LTE_LC_EDRX_MODULE} to be enabled.
1547+
* @note Requires `CONFIG_LTE_LC_EDRX_MODULE` to be enabled.
15481548
*
15491549
* @param[in] mode LTE mode to which the PTW value applies.
15501550
* @param[in] ptw Paging Time Window value as a null-terminated string.
@@ -1563,7 +1563,7 @@ int lte_lc_ptw_set(enum lte_lc_lte_mode mode, const char *ptw);
15631563
*
15641564
* For reference see 3GPP 27.007 Ch. 7.40.
15651565
*
1566-
* @note Requires @kconfig{CONFIG_LTE_LC_EDRX_MODULE} to be enabled.
1566+
* @note Requires `CONFIG_LTE_LC_EDRX_MODULE` to be enabled.
15671567
*
15681568
* @param[in] mode LTE mode to which the eDRX value applies.
15691569
* @param[in] edrx eDRX value as a null-terminated string.
@@ -1577,20 +1577,20 @@ int lte_lc_edrx_param_set(enum lte_lc_lte_mode mode, const char *edrx);
15771577
/**
15781578
* Request modem to enable or disable use of eDRX.
15791579
*
1580-
* eDRX parameters can be set using @kconfig{CONFIG_LTE_EDRX_REQ_VALUE_LTE_M},
1581-
* @kconfig{CONFIG_LTE_EDRX_REQ_VALUE_NBIOT}, @kconfig{CONFIG_LTE_PTW_VALUE_LTE_M} and
1582-
* @kconfig{CONFIG_LTE_PTW_VALUE_NBIOT}, or by calling lte_lc_edrx_param_set() and
1580+
* eDRX parameters can be set using `CONFIG_LTE_EDRX_REQ_VALUE_LTE_M`,
1581+
* `CONFIG_LTE_EDRX_REQ_VALUE_NBIOT`, `CONFIG_LTE_PTW_VALUE_LTE_M` and
1582+
* `CONFIG_LTE_PTW_VALUE_NBIOT`, or by calling lte_lc_edrx_param_set() and
15831583
* lte_lc_ptw_set().
15841584
*
15851585
* For reference see 3GPP 27.007 Ch. 7.40.
15861586
*
1587-
* @note @kconfig{CONFIG_LTE_EDRX_REQ} can be set to enable eDRX, which is generally sufficient.
1587+
* @note `CONFIG_LTE_EDRX_REQ` can be set to enable eDRX, which is generally sufficient.
15881588
* This option allows explicit disabling/enabling of eDRX requesting after modem
15891589
* initialization. Calling this function for run-time control is possible, but it should be
1590-
* noted that conflicts may arise with the value set by @kconfig{CONFIG_LTE_EDRX_REQ} if it is
1590+
* noted that conflicts may arise with the value set by `CONFIG_LTE_EDRX_REQ` if it is
15911591
* called during modem initialization.
15921592
*
1593-
* @note Requires @kconfig{CONFIG_LTE_LC_EDRX_MODULE} to be enabled.
1593+
* @note Requires `CONFIG_LTE_LC_EDRX_MODULE` to be enabled.
15941594
*
15951595
* @param[in] enable @c true to enable eDRX, @c false to disable eDRX.
15961596
*
@@ -1604,7 +1604,7 @@ int lte_lc_edrx_req(bool enable);
16041604
*
16051605
* @param[out] edrx_cfg eDRX configuration.
16061606
*
1607-
* @note Requires @kconfig{CONFIG_LTE_LC_EDRX_MODULE} to be enabled.
1607+
* @note Requires `CONFIG_LTE_LC_EDRX_MODULE` to be enabled.
16081608
*
16091609
* @retval 0 if successful.
16101610
* @retval -EINVAL if input argument was invalid.
@@ -1696,7 +1696,7 @@ int lte_lc_lte_mode_get(enum lte_lc_lte_mode *mode);
16961696
*
16971697
* @note This feature is only supported by modem firmware versions >= 1.3.0.
16981698
*
1699-
* @note Requires @kconfig{CONFIG_LTE_LC_NEIGHBOR_CELL_MEAS_MODULE} to be enabled.
1699+
* @note Requires `CONFIG_LTE_LC_NEIGHBOR_CELL_MEAS_MODULE` to be enabled.
17001700
*
17011701
* @param[in] params Search type parameters or @c NULL to initiate a measurement with the default
17021702
* parameters. See @ref lte_lc_ncellmeas_params for more information.
@@ -1711,7 +1711,7 @@ int lte_lc_neighbor_cell_measurement(struct lte_lc_ncellmeas_params *params);
17111711
/**
17121712
* Cancel an ongoing neighbor cell measurement.
17131713
*
1714-
* @note Requires @kconfig{CONFIG_LTE_LC_NEIGHBOR_CELL_MEAS_MODULE} to be enabled.
1714+
* @note Requires `CONFIG_LTE_LC_NEIGHBOR_CELL_MEAS_MODULE` to be enabled.
17151715
*
17161716
* @retval 0 if neighbor cell measurement was cancelled.
17171717
* @retval -EFAULT if AT command failed.
@@ -1724,7 +1724,7 @@ int lte_lc_neighbor_cell_measurement_cancel(void);
17241724
* Connection evaluation parameters can be used to determine the energy efficiency of data
17251725
* transmission before the actual data transmission.
17261726
*
1727-
* @note Requires @kconfig{CONFIG_LTE_LC_CONN_EVAL_MODULE} to be enabled.
1727+
* @note Requires `CONFIG_LTE_LC_CONN_EVAL_MODULE` to be enabled.
17281728
*
17291729
* @param[out] params Connection evaluation parameters.
17301730
*
@@ -1776,7 +1776,7 @@ int lte_lc_modem_events_disable(void);
17761776
* "nRF91 AT Commands - Command Reference Guide" for more information and in-depth explanations of
17771777
* periodic search configuration.
17781778
*
1779-
* @note Requires @kconfig{CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE} to be enabled.
1779+
* @note Requires `CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE` to be enabled.
17801780
*
17811781
* @param[in] cfg Periodic search configuration.
17821782
*
@@ -1790,7 +1790,7 @@ int lte_lc_periodic_search_set(const struct lte_lc_periodic_search_cfg *const cf
17901790
/**
17911791
* Get the configured periodic search parameters.
17921792
*
1793-
* @note Requires @kconfig{CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE} to be enabled.
1793+
* @note Requires `CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE` to be enabled.
17941794
*
17951795
* @param[out] cfg Periodic search configuration.
17961796
*
@@ -1806,7 +1806,7 @@ int lte_lc_periodic_search_get(struct lte_lc_periodic_search_cfg *const cfg);
18061806
/**
18071807
* Clear the configured periodic search parameters.
18081808
*
1809-
* @note Requires @kconfig{CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE} to be enabled.
1809+
* @note Requires `CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE` to be enabled.
18101810
*
18111811
* @retval 0 if the configuration was cleared.
18121812
* @retval -EFAULT if an AT command could not be sent to the modem.
@@ -1820,7 +1820,7 @@ int lte_lc_periodic_search_clear(void);
18201820
* This can be used for example when modem is in sleep state between periodic searches. The search
18211821
* is performed only when the modem is in sleep state between periodic searches.
18221822
*
1823-
* @note Requires @kconfig{CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE} to be enabled.
1823+
* @note Requires `CONFIG_LTE_LC_PERIODIC_SEARCH_MODULE` to be enabled.
18241824
*
18251825
* @retval 0 if the search request was successfully delivered to the modem.
18261826
* @retval -EFAULT if an AT command could not be sent to the modem.

0 commit comments

Comments
 (0)