.. include:: custom_tools.txt

.. sectnum::
.. _ccr_coding_standards:

********************
CCR Coding Standards
********************

.. toctree::
    :maxdepth: 6
    :caption: Contents:
    :numbered:

    authors_note
    introduction
    definitions
    names
    macro_names
    variable_names
    custom_data_types
    function_names
    abbreviations
    whitespace
    alignment
    indentation
    database_fields
    efficiency
    formal_arguments
    date_format
    macro_use_policy
    dma_use_policy
    file_sections
    documentation
    include_policy
    vb_and_c_sharp
    appendix_a
    appendix_b
    glossary
    bibliography

.. toctree::
    :maxdepth: 6
    :caption: Quick-Start for Embedded C Systems:
    :numbered:

    embedded_rules_quickstart



Tables
******

* :ref:`Naming Senior Policy <naming senior policy>`
* :ref:`macro name parts`
* :ref:`Variable Name Parts <variable name parts>`
* :ref:`scope prefixes`
* :ref:`type prefixes`
* :ref:`portable integer type prefixes`
* :ref:`non-portable integer type prefixes`
* :ref:`pointer prefix`
* :ref:`array prefix`
* :ref:`prefix exceptions`
* :ref:`custom type prefix examples`
* :ref:`spelled-out custom type prefix examples`
* :ref:`Function Name Parts <function name parts>`
* :ref:`common abbreviations`
* :ref:`common lvgl abbreviations`
* :ref:`Documentation Priorities <documentation priorities>`
* :ref:`change log`



Code Examples
*************
* :ref:`Code-Clarity Example <code-clarity example>`
* :ref:`Macro-Name Examples <macro-name examples>`
* :ref:`Example of Code-Inlining with Macros <example of code-inlining with macros>`
* :ref:`Example of Correct Use of 'bool' <bool correct-use example>`
* :ref:`Examples of Sharing Enumerations Between VB.NET and C <enumeration examples in vb and c>`
* :ref:`Examples of DMA Variables <dma variable naming examples>`
* :ref:`Examples of Variable Prefix Exceptions <examples of prefix exceptions>`
* :ref:`Examples of Partially-Defined Types <partially-defined type examples>`
* :ref:`Examples of Custom-Type Alignment Rules <custom-type-alignment examples>`
* :ref:`Examples of Library Names vs Function Names <library-vs-app function name examples>`
* :ref:`Examples of Code-Execution Efficiency <code-efficiency examples>`
* :ref:`Example of Formal-Argument Naming <formal arguments example>`
* :ref:`Examples of Indentation Rules <indentation examples>`
* :ref:`Examples of Safe-vs-Unsafe Macro Use <macro use policy>`
* :ref:`Template for an H File Header <template for h file header>`
* :ref:`Template for an C File Header <template for c file header>`
* :ref:`Template for an H File <template for an h file>`
* :ref:`Template for an C File <template for a c file>`
* :ref:`Template for Project Documentation <project documentation template>`
* :ref:`Template for Cluster Documentation <cluster documentation template>`
* :ref:`Templates for Doxygen Comments <doxygen comment templates>`
* :ref:`Examples of Commenting Out Code <examples of commenting out code>`
* :ref:`Example of Conditional Doxygen Block <examples of conditional doxygen blocks>`
* :ref:`Example of Function-Definition Comment <function definition comment example>`
* :ref:`Example of Doxygen Cross-Referencing <doxygen cross-referencing example>`



Indices
*******

* :ref:`genindex`