From 3a1b14314b9b7c00aa78eee0b2aa5b492f2dd40f Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Marc=20Andr=C3=A9=20Tanner?= Date: Wed, 3 May 2017 11:12:42 +0200 Subject: text: add miscellaneous documentation section --- doc/text.rst | 6 ++++++ text.h | 19 +++++++++++-------- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/doc/text.rst b/doc/text.rst index 210336b..767bf29 100644 --- a/doc/text.rst +++ b/doc/text.rst @@ -121,3 +121,9 @@ Save .. doxygengroup:: save :content-only: + +Miscellaneous +------------- + +.. doxygengroup:: misc + :content-only: diff --git a/text.h b/text.h index d53d1ed..607f239 100644 --- a/text.h +++ b/text.h @@ -252,15 +252,8 @@ Mark text_mark_set(Text*, size_t pos); * @return The byte position or `EPOS` for an invalid mark. */ size_t text_mark_get(Text*, Mark); -/** @} */ - -/** - * Check whether ``ptr`` is part of a memory mapped region associated with - * this text instance. - */ -bool text_mmaped(Text*, const char *ptr); - /** + * @} * @defgroup save * @{ */ @@ -352,6 +345,16 @@ ssize_t text_write(Text*, int fd); * @return The number of bytes written or ``-1`` in case of an error. */ ssize_t text_write_range(Text*, Filerange*, int fd); +/** + * @} + * @defgroup misc + * @{ + */ +/** + * Check whether ``ptr`` is part of a memory mapped region associated with + * this text instance. + */ +bool text_mmaped(Text*, const char *ptr); /** @} */ size_t text_insert_newline(Text*, size_t pos); -- cgit v1.2.3