Explorar el Código

Add documentation string for method

dustin.born hace 7 años
padre
commit
893186b5a3
Se han modificado 1 ficheros con 5 adiciones y 1 borrados
  1. 5 1
      code_boost/src/cxx/botnet_comm_processor.cpp

+ 5 - 1
code_boost/src/cxx/botnet_comm_processor.cpp

@@ -17,7 +17,11 @@ botnet_comm_processor::botnet_comm_processor(const py::list &messages_pyboost){
 botnet_comm_processor::botnet_comm_processor(){
 }
 
-
+/**
+ * Set the messages of this communication processor.
+ * @param messages_pyboost The abstract communication messages
+ *    represented as (python) list containing (python) dicts.
+ */
 void botnet_comm_processor::set_messages(const py::list &messages_pyboost){
     messages.clear();
     for (int i = 0; i < len(messages_pyboost); i++){