ch0ic3/cutter
1
0
Fork 0
mirror of https://github.com/rizinorg/cutter.git synced 2024-12-24 05:45:27 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Added information about docstring (#1239)

Browse Source
This commit is contained in:
xarkes 2019-03-08 08:20:13 +01:00 committed by GitHub
parent e3ddbf6255
commit 426cf96b50
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 14 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/source/code.rst
View File

@ -72,6 +72,20 @@ to the style is:
astyle --project=src/Cutter.astylerc src/filename.cpp 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 Loops
^^^^^ ^^^^^