diff --git a/docs/libnm-util/Makefile.am b/docs/libnm-util/Makefile.am index c528e702f6..51f00caa92 100644 --- a/docs/libnm-util/Makefile.am +++ b/docs/libnm-util/Makefile.am @@ -32,7 +32,9 @@ CFILE_GLOB= IGNORE_HFILES= \ crypto.h \ nm-setting-ip6-config.h \ - nm-setting-template.h + nm-setting-template.h \ + nm-utils-private.h \ + nm-param-spec-specialized.h # Images to copy into HTML directory. HTML_IMAGES = diff --git a/libnm-util/nm-utils.c b/libnm-util/nm-utils.c index 5cfda95e79..d449e789b3 100644 --- a/libnm-util/nm-utils.c +++ b/libnm-util/nm-utils.c @@ -45,6 +45,15 @@ #include "nm-setting-ip6-config.h" #include "crypto.h" +/** + * SECTION:nm-utils + * @short_description: Utility functions + * @include: nm-utils.h + * + * A collection of utility functions for working SSIDs, IP addresses, WiFi + * access points and devices, among other things. + */ + /* IP6 currently incomplete */ GSList *nm_utils_ip6_addresses_from_gvalue (const GValue *value); void nm_utils_ip6_addresses_to_gvalue (GSList *list, GValue *value); diff --git a/libnm-util/nm-utils.h b/libnm-util/nm-utils.h index e09f03728a..629bc59fee 100644 --- a/libnm-util/nm-utils.h +++ b/libnm-util/nm-utils.h @@ -35,6 +35,11 @@ /* The API defined here is _NOT_ guaranteed in any way!! */ /*********************************************************/ +/** + * nm_print_backtrace: + * + * Prints a backtrace of the calling process to the logging location. + */ #define nm_print_backtrace() \ G_STMT_START \ { \ @@ -59,6 +64,12 @@ G_STMT_START \ } \ G_STMT_END +/** + * nm_get_timestamp: + * @timestamp: location in which to place the current timestamp + * + * For debugging only. + */ #define nm_get_timestamp(timestamp) \ G_STMT_START \ { \ @@ -153,8 +164,6 @@ GHashTable *nm_utils_gvalue_hash_dup (GHashTable *hash); void nm_utils_slist_free (GSList *list, GDestroyNotify elem_destroy_fn); -void nm_utils_register_value_transformations (void); - typedef enum { NMU_SEC_INVALID = 0, NMU_SEC_NONE,