X-Git-Url: http://git.efficios.com/?a=blobdiff_plain;f=doc%2Fapi%2FREADME.adoc;h=3e6ce69f76048944eed34ea9f2c03cd98ce97c87;hb=50842bdc4c21f3de2b63e29cdac730af8b6dcca6;hp=52179820fad18f95d5e15df6b635baabbccc86b7;hpb=3758cf401cebb5f099f4f09795b4fbcda1cf4e42;p=babeltrace.git diff --git a/doc/api/README.adoc b/doc/api/README.adoc index 52179820..3e6ce69f 100644 --- a/doc/api/README.adoc +++ b/doc/api/README.adoc @@ -38,8 +38,7 @@ Use a warning command if this message is really important. @postrefcountsame{stream_class} @post Some custom postcondition. -@sa bt_ctf_stream_class_get_name(): Returns the name of a given - stream class. +@sa btstream_class_get_name(): Returns the name of a given stream class. */ ---- @@ -50,9 +49,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