base/functional/README.md

   1 # base/functional library
   2
   3 [TOC]
   4
   5 ## What goes here
   6
   7 This directory contains function objects from future STL versions and closely
   8 related types.
   9
  10 Things should be moved here that are generally applicable across the code base.
  11 Don't add things here just because you need them in one place and think others
  12 may someday want something similar. You can put specialized function objects in
  13 your component's directory and we can promote them here later if we feel there
  14 is broad applicability.
  15
  16 ### Design and naming
  17
  18 Fundamental [//base principles](../README.md#design-and-naming) apply, i.e.:
  19
  20 Function objects should either come directly from the STL or adhere as closely
  21 to STL as possible. Functions and behaviors not present in STL should only be
  22 added when they are related to the specific function objects.
  23
  24 For STL-like function objects our policy is that they should use STL-like naming
  25 even when it may conflict with the style guide. So functions and class names
  26 should be lower case with underscores. Non-STL-like classes and functions should
  27 use Google naming. Be sure to use the base namespace.