src/main/doxy/strategies.h

   1 /* FreeEMS - the open source engine management system
   2  *
   3  * Copyright 2010 Fred Cooke
   4  *
   5  * This file is part of the FreeEMS project.
   6  *
   7  * FreeEMS software is free software: you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation, either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * FreeEMS software is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with any FreeEMS software.  If not, see http://www.gnu.org/licenses/
  19  *
  20  * We ask that if you make any changes to this file you email them upstream to
  21  * us at admin(at)diyefi(dot)org or, even better, fork the code on github.com!
  22  *
  23  * Thank you for choosing FreeEMS to run your engine!
  24  */
  25
  26 /** @page generalStrategies General Strategies
  27  *
  28  * This page exists to document general coding strategies used in this
  29  * firmware. Each item should contain a title, description, situations
  30  * it is useful in and somewhere you can see an example of it in use.
  31  *
  32  * Reading/Writing from/to a specific page :
  33  *
  34  * Save the current page value to a variable, change the page value to the desired one, read or write the paged memory, change the page back and return the value
  35  *
  36  * This is applicable to all three available memory types: Flash, RAM and EEPROM.
  37  *
  38  * Examples of its use can be found in flashWrite.c
  39  *
  40  * @todo TODO TBC (other strategies)
  41  */
  42
  43 /** @file
  44  *
  45  * @ingroup doxygenDocFiles
  46  * @brief Doxygen General Strategies page definition
  47  */