From e9dad4375bcd65cdcc4a61a48ddbc6155e394a46 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 7 Jan 2021 17:56:08 +0100 Subject: Use globally unique Doxygen group names This is necessary to avoid clashes when building unified documentation as a subproject. --- doc/c/overview.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) (limited to 'doc/c') diff --git a/doc/c/overview.rst b/doc/c/overview.rst index 95862368..2b204155 100644 --- a/doc/c/overview.rst +++ b/doc/c/overview.rst @@ -5,14 +5,14 @@ Overview .. default-domain:: c .. highlight:: c -The API revolves around two main types: the :doc:`api/reader`, +The API revolves around two main types: the :doc:`api/serd_reader`, which reads text and fires callbacks, -and the :doc:`api/writer`, +and the :doc:`api/serd_writer`, which writes text when driven by corresponding functions. Both work in a streaming fashion but still support pretty-printing, so the pair can be used to pretty-print, translate, or otherwise process arbitrarily large documents very quickly. -The context of a stream is tracked by the :doc:`api/env`, +The context of a stream is tracked by the :doc:`api/serd_env`, which stores the current base URI and set of namespace prefixes. The complete API is declared in ``serd.h``: -- cgit v1.2.1