docs/dev-manual/style.rst

   1 Style guidelines
   2 ================
   3
   4 .. _style-guidelines:
   5
   6 Different style guidelines are available under the respective sections of
   7 this page.
   8
   9 .. toctree::
  10    :maxdepth: 2
  11
  12    formatting
  13    includestyle
  14    naming
  15    language-features
  16    doxygen
  17    reportstyle
  18    commitstyle
  19    error-handling
  20
  21 :doc:`formatting`
  22   Guidelines for indentation and other code formatting.
  23 :doc:`includestyle`
  24   Guidelines for #include style (ordering, paths to use, etc.).
  25 :doc:`naming`
  26   Naming conventions for files and various code constructs.
  27 :doc:`language-features`
  28   Allowed language features.
  29 :doc:`error-handling`
  30   How to handle errors at run time
  31 :ref:`dev-doxygen-guidelines`
  32   Guidelines for using Doxygen to document the source code are currently in a
  33   section on the page on general Doxygen usage.
  34 :doc:`reportstyle`
  35   Guidelines for preparing and formatting bug reports on redmine.
  36 :doc:`commitstyle`
  37   Guidelines for formatting git commits when sending in proposed fixes for code review.
  38
  39 .. TODO: Add more guidelines