Doc file (meant for reading, not compiling) that formally defines the coding style for the rest of the project. More...

Detailed Description

Doc file (meant for reading, not compiling) that formally defines the coding style for the rest of the project.

Todo:: There are a few little to-dos inside the Doxygen-skipped main body of doc-coding_style.cpp; check them out.

Todo:: A script/tool/something that would auto-scan the code for violations of cosmetic conventions described in doc-coding_style.cpp. It need not be perfect or comprehensive. Humans tend to have difficulty following lots of conventions, and it then clutters up code reviews subsequently.

Todo:: In all of Flow, scan for the unintentional use of the period character in auto-brief summaries in many doc headers. A period will be assumed to be the end of the brief summary. We've been disciplined about this, but I (ygoldfel) just realized that, e.g., "boost.asio" has a period and yet is present in at least some doc headers. Fix those in some consistent yet palatable way, so that the Doxygen output for those isn't prematurely truncated. (Check that Doxygen isn't smart enough to figure it out already. If it is, delete this to-do.)