From 1c1da604afcadff51ed3d51fc76ec28b5af3683e Mon Sep 17 00:00:00 2001 From: Marko Lindqvist Date: Sat, 28 Jan 2023 08:20:55 +0200 Subject: [PATCH 24/24] astring.h: Mark inline functions for doxygen See osdn #46560 Signed-off-by: Marko Lindqvist --- utility/astring.h | 21 ++++++++++----------- 1 file changed, 10 insertions(+), 11 deletions(-) diff --git a/utility/astring.h b/utility/astring.h index c9032b5ecf..8723308638 100644 --- a/utility/astring.h +++ b/utility/astring.h @@ -1,4 +1,4 @@ -/********************************************************************** +/*********************************************************************** Freeciv - Copyright (C) 1996 - A Kjeldberg, L Gregersen, P Unold This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by @@ -34,9 +34,9 @@ extern "C" { #define n_alloc _private_n_alloc_ struct astring { - char *str; /* the string */ - size_t n; /* size most recently requested */ - size_t n_alloc; /* total allocated */ + char *str; /* The string */ + size_t n; /* Size most recently requested */ + size_t n_alloc; /* Total allocated */ }; /* Can assign this in variable declaration to initialize: @@ -84,8 +84,7 @@ void astr_copy(struct astring *dest, const struct astring *src) fc__attribute((nonnull (1, 2))); - -/**************************************************************************** +/************************************************************************//** Returns the string. ****************************************************************************/ static inline const char *astr_str(const struct astring *astr) @@ -93,7 +92,7 @@ static inline const char *astr_str(const struct astring *astr) return astr->str; } -/**************************************************************************** +/************************************************************************//** Returns the length of the string. ****************************************************************************/ static inline size_t astr_len(const struct astring *astr) @@ -101,7 +100,7 @@ static inline size_t astr_len(const struct astring *astr) return (NULL != astr->str ? strlen(astr->str) : 0); } -/**************************************************************************** +/************************************************************************//** Returns the current size requested for the string. ****************************************************************************/ static inline size_t astr_size(const struct astring *astr) @@ -109,7 +108,7 @@ static inline size_t astr_size(const struct astring *astr) return astr->n; } -/**************************************************************************** +/************************************************************************//** Returns the real size requested for the string. ****************************************************************************/ static inline size_t astr_capacity(const struct astring *astr) @@ -117,7 +116,7 @@ static inline size_t astr_capacity(const struct astring *astr) return astr->n_alloc; } -/**************************************************************************** +/************************************************************************//** Returns whether the string is empty or not. ****************************************************************************/ static inline bool astr_empty(const struct astring *astr) @@ -133,4 +132,4 @@ static inline bool astr_empty(const struct astring *astr) } #endif /* __cplusplus */ -#endif /* FC__ASTRING_H */ +#endif /* FC__ASTRING_H */ -- 2.39.0