Further cleanup of comments, partial Doxygen-style
Following up on #3231
This commit is contained in:
@ -1,4 +1,4 @@
|
||||
/*
|
||||
/**
|
||||
* Marlin 3D Printer Firmware
|
||||
* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
|
||||
*
|
||||
@ -20,29 +20,26 @@
|
||||
*
|
||||
*/
|
||||
|
||||
/**
|
||||
* M100 Free Memory Watcher
|
||||
*
|
||||
* This code watches the free memory block between the bottom of the heap and the top of the stack.
|
||||
* This memory block is initialized and watched via the M100 command.
|
||||
*
|
||||
* M100 I Initializes the free memory block and prints vitals statistics about the area
|
||||
* M100 F Identifies how much of the free memory block remains free and unused. It also
|
||||
* detects and reports any corruption within the free memory block that may have
|
||||
* happened due to errant firmware.
|
||||
* M100 D Does a hex display of the free memory block along with a flag for any errant
|
||||
* data that does not match the expected value.
|
||||
* M100 C x Corrupts x locations within the free memory block. This is useful to check the
|
||||
* correctness of the M100 F and M100 D commands.
|
||||
*
|
||||
* Initial version by Roxy-3DPrintBoard
|
||||
*/
|
||||
#define M100_FREE_MEMORY_DUMPER // Comment out to remove Dump sub-command
|
||||
#define M100_FREE_MEMORY_CORRUPTOR // Comment out to remove Corrupt sub-command
|
||||
|
||||
|
||||
// M100 Free Memory Watcher
|
||||
//
|
||||
// This code watches the free memory block between the bottom of the heap and the top of the stack.
|
||||
// This memory block is initialized and watched via the M100 command.
|
||||
//
|
||||
// M100 I Initializes the free memory block and prints vitals statistics about the area
|
||||
// M100 F Identifies how much of the free memory block remains free and unused. It also
|
||||
// detects and reports any corruption within the free memory block that may have
|
||||
// happened due to errant firmware.
|
||||
// M100 D Does a hex display of the free memory block along with a flag for any errant
|
||||
// data that does not match the expected value.
|
||||
// M100 C x Corrupts x locations within the free memory block. This is useful to check the
|
||||
// correctness of the M100 F and M100 D commands.
|
||||
//
|
||||
// Initial version by Roxy-3DPrintBoard
|
||||
//
|
||||
//
|
||||
|
||||
|
||||
#include "Marlin.h"
|
||||
|
||||
#if ENABLED(M100_FREE_MEMORY_WATCHER)
|
||||
|
Reference in New Issue
Block a user