mrquincle

Some example of a documented function

Check the Sphinx documentation, heavily used within Python. This is a reStructedText doc: https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html#python-signatures

.. py:function:: send_message(sender, recipient, message_body, [priority=1])

   Send a message to a recipient

 :param str sender: The person sending the message

mrquincle

/**
 * Copy <cs_Math> from bluenet repository and if not present add to it the following function.
 
   template<class T, class M, class U=int>
   constexpr inline decltype(auto) DecreaseMember(T& obj, M member, U diff=1) {
	   obj.*member = SafeAdd(obj.*member, -diff);
	   return obj.*member;
   }

 * Compile with g++ -I. main.cpp -o main