principles.h

Go to the documentation of this file.

/*
 * principles.h
 *
 * Not a real header!  This is just here for Doxygen.  Don't use this header.
 */

/// \ingroup wavepacket_top
/// \defgroup princip_guide Principles and Guidelines
///
/// General principles and coding guidelines for the Wavepacket family of
/// libraries and programs.
///

/// \ingroup princip_guide
/// \defgroup principles General Principles
/// General Principles
///
/// These are general principles that guide all projects.  Or at least, these
/// are the principles that I adhere to and enforce for my projects:
///
/// - <b>Security is the top concern.</b>  We respect local policies and
///     permissions (in particular, we never try to work around them).  We
///     write defensive code that does not allow people to intentionally or
///     inadvertently compromise their system through our software.
///
/// - <b>Our software is a guest on the user's machine.</b>  We ask permission
///     before doing anything interesting or dangerous.  We leave if asked,
///     and clean up after ourselves.
///
/// - <b>We respect privacy.</b>  Our software excels at what it is
///     advertised to do, and does nothing else.  We take only what personal
///     information is required to operate (if any), do not move it off the
///     host computer without explicit permission, and never share it with
///     third parties ever.
///
/// - <b>We are stable.</b>  Our software can run continuously for weeks
///     or months or years and not crash due to leaks or other problems.
///     We handle invalid inputs and behaviors gracefully.
///  
/// - <b>We are fast and frugal.</b>  Every bit of software is profiled and
///     timed.  We use the minimum resources required to do the job, and do
///     it fast.
///
/// For security tips, see the SANS Top 25 Most Dangerous Programming Errors:
/// http://www.sans.org/top25errors/
///