From 68a4dc89f5e00aa6e2780f4f96011b92961b7a80 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Tue, 25 Nov 2014 00:23:48 -0500 Subject: Single-page API documentation with unified style. --- lv2/lv2plug.in/ns/ext/log/log.h | 12 ++++++++++-- lv2/lv2plug.in/ns/ext/log/logger.h | 19 ++++++++++--------- 2 files changed, 20 insertions(+), 11 deletions(-) (limited to 'lv2/lv2plug.in/ns/ext/log') diff --git a/lv2/lv2plug.in/ns/ext/log/log.h b/lv2/lv2plug.in/ns/ext/log/log.h index d27e549..5245010 100644 --- a/lv2/lv2plug.in/ns/ext/log/log.h +++ b/lv2/lv2plug.in/ns/ext/log/log.h @@ -15,8 +15,12 @@ */ /** - @file log.h C header for the LV2 Log extension - . + @defgroup log Log + + Interface for plugins to log via the host; see + for details. + + @{ */ #ifndef LV2_LOG_H @@ -97,3 +101,7 @@ typedef struct _LV2_Log { #endif #endif /* LV2_LOG_H */ + +/** + @} +*/ diff --git a/lv2/lv2plug.in/ns/ext/log/logger.h b/lv2/lv2plug.in/ns/ext/log/logger.h index 1b03866..094dd42 100644 --- a/lv2/lv2plug.in/ns/ext/log/logger.h +++ b/lv2/lv2plug.in/ns/ext/log/logger.h @@ -15,13 +15,14 @@ */ /** - @file logger.h Convenience API for easy logging in plugin code. + @defgroup logger Logger + @ingroup log - This file provides simple wrappers for the most common log operations for - use in plugin implementations. If host support for logging is not - available, then these functions will print to stderr instead. + Convenience API for easy logging in plugin code. This API provides simple + wrappers for logging from a plugin, which automatically fall back to + printing to stderr if host support is unavailabe. - This header is non-normative, it is provided for convenience. + @{ */ #ifndef LV2_ATOM_LOGGER_H @@ -135,12 +136,12 @@ lv2_log_warning(LV2_Log_Logger* logger, const char* fmt, ...) return ret; } -/** - @} -*/ - #ifdef __cplusplus } /* extern "C" */ #endif #endif /* LV2_LOG_LOGGER_H */ + +/** + @} +*/ -- cgit v1.2.1