Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

plgd/dps: fix doxygen documentation #643

Merged
merged 1 commit into from
Sep 18, 2024
Merged

plgd/dps: fix doxygen documentation #643

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 27 additions & 6 deletions include/plgd/plgd_dps.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,14 @@
*
****************************************************************************/

/**
* @file plgd_dps.h
*
* @brief Device provisioning
*
* @author Daniel Adam
*/

#ifndef PLGD_DPS_H
#define PLGD_DPS_H

Expand All @@ -41,6 +49,14 @@
#error "OC_STORAGE must be defined"
#endif

/**
* \defgroup dps Device provisioning
*
* A facitility to securely provision and preconfigure devices.
*
* @{
*/

#include "oc_export.h"
#include "oc_client_state.h"
#include "oc_cloud.h"
Expand Down Expand Up @@ -395,10 +411,12 @@ OC_API
void plgd_dps_set_configuration_resource(plgd_dps_context_t *ctx, bool create)
OC_NONNULL();

/**
* @brief Maximal size of the retry configuration array
*/
enum { PLGD_DPS_MAX_RETRY_VALUES_SIZE = 8 };
enum {
/**
* @brief Maximal size of the retry configuration array
*/
PLGD_DPS_MAX_RETRY_VALUES_SIZE = 8
};

/**
* @brief Configure retry counter.
Expand Down Expand Up @@ -726,11 +744,12 @@ plgd_dps_dhcp_set_values_from_vendor_encapsulated_options(
* @param ctx dps context (cannot be NULL)
* @param endpoint endpoint of the provisioning server (cannot be NULL)
*
* @deprecated Use plgd_dps_add_endpoint_address instead.
* @deprecated replaced by plgd_dps_add_endpoint_address in v2.2.5.15
*/
OC_API
void plgd_dps_set_endpoint(plgd_dps_context_t *ctx, const char *endpoint)
OC_NONNULL() OC_DEPRECATED("Use plgd_dps_add_endpoint_address instead.");
OC_NONNULL()
OC_DEPRECATED("replaced by plgd_dps_add_endpoint_address in v2.2.5.15");

/**
* @brief Copy the selected endpoint address of the DPS service to output
Expand Down Expand Up @@ -856,4 +875,6 @@ const oc_endpoint_address_t *plgd_dps_selected_endpoint_address(
}
#endif

/** @} */

#endif /* PLGD_DPS_H */
Loading