From 426cf96b501ec264421d506e92f845c5fb53aeaa Mon Sep 17 00:00:00 2001 From: xarkes Date: Fri, 8 Mar 2019 08:20:13 +0100 Subject: [PATCH] Added information about docstring (#1239) --- docs/source/code.rst | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/docs/source/code.rst b/docs/source/code.rst index 1c6832e6..7d7bf11c 100644 --- a/docs/source/code.rst +++ b/docs/source/code.rst @@ -72,6 +72,20 @@ to the style is: astyle --project=src/Cutter.astylerc src/filename.cpp + +Docstrings +^^^^^^^^^^ + +Our API reference is generated using Doxygen, so when it comes to +function documentation, please use the following format: + +.. code:: cpp + + /** + * @brief Add a new param to the accumulator + */ + virtual void accumulate(RefreshDeferrerParams params) =0; + Loops ^^^^^