Giters

IFL-CAMP / simple

S.I.M.P.L.E. - Smart Intuitive Messaging Platform with Less Effort. A Cross-Platform C++ Library to Exchange Data Across Network.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Consistently add parameter names in header files

TheHugeManatee opened this issue · comments

commented

Most methods of the message classes do not have the parameter names in the declarations in the header files.
Missing more elaborate doxygen strings on the parameters as well, in some places it is hard to figure out the semantics of the constructor or method parameters.

Example:

/**
 * @brief Construct a Header message using the given parameters.
 */
Header(int, const std::string&, long long);

Without looking at the source file, you can't really figure out what is what. Was the timestamp the first or the last parameter? Could the last param be the sequence number?

Suggested fix: Add all parameter names in the header files. I can do it but won't do the busy work if there was a conscious decision not to include the parameter names in the header files for some reason?