docs/dev-manual/style.rst

   1 .. _style-guidelines:
   2
   3 Style guidelines
   4 ================
   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    reportstyle
  17    commitstyle
  18    error-handling
  19
  20 :doc:`formatting`
  21   Guidelines for indentation and other code formatting.
  22 :doc:`includestyle`
  23   Guidelines for #include style (ordering, paths to use, etc.).
  24 :doc:`naming`
  25   Naming conventions for files and various code constructs.
  26 :doc:`language-features`
  27   Allowed language features.
  28 :doc:`error-handling`
  29   How to handle errors at run time
  30 :ref:`dev-doxygen-guidelines`
  31   Guidelines for using Doxygen to document the source code are currently in a
  32   section on the page on general Doxygen usage.
  33 :doc:`reportstyle`
  34   Guidelines for preparing and formatting bug reports on redmine.
  35 :doc:`commitstyle`
  36   Guidelines for formatting git commits when sending in proposed fixes for code review.
  37
  38 .. TODO: Add more guidelines