From 03559ebf94365bf78981f8818cce36e42b5446f6 Mon Sep 17 00:00:00 2001 From: Philippe Proulx Date: Fri, 2 Dec 2016 12:06:40 -0500 Subject: [PATCH] doc/api/README.adoc: fix double "followed by" MIME-Version: 1.0 Content-Type: text/plain; charset=utf8 Content-Transfer-Encoding: 8bit Signed-off-by: Philippe Proulx Signed-off-by: Jérémie Galarneau --- doc/api/README.adoc | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/doc/api/README.adoc b/doc/api/README.adoc index 52179820f..903988f44 100644 --- a/doc/api/README.adoc +++ b/doc/api/README.adoc @@ -50,9 +50,9 @@ Use a warning command if this message is really important. * Start the block with https://www.stack.nl/\~dimitri/doxygen/manual/commands.html#cmdbrief[`@brief`] - followed by a space followed by a tab followed by the brief - description. If the brief description needs more than one line, start - the following lines with a tab character. + followed by a tab followed by the brief description. If the brief + description needs more than one line, start the following lines with a + tab character. + Try to always refer to all the function or macro parameters in the brief description. The sentence _must_ begin with a verb, third-person -- 2.34.1