diff --git a/Marlin/Conditionals.h b/Marlin/Conditionals.h index bea1cc7725..376946ab7c 100644 --- a/Marlin/Conditionals.h +++ b/Marlin/Conditionals.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Conditionals.h * Defines that depend on configuration but are not editable. */ diff --git a/Marlin/Configuration.h b/Marlin/Configuration.h index f8470b92e9..0ded362096 100644 --- a/Marlin/Configuration.h +++ b/Marlin/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h index cc19026332..d137169d1a 100644 --- a/Marlin/Configuration_adv.h +++ b/Marlin/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/Default_Version.h b/Marlin/Default_Version.h index 39b1fcbd2e..f8259b40c8 100644 --- a/Marlin/Default_Version.h +++ b/Marlin/Default_Version.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * This file is a placeholder for a file which could be distributed in an archive * It takes the place of an automatically created "_Version.h" which is generated during the build process */ diff --git a/Marlin/M100_Free_Mem_Chk.cpp b/Marlin/M100_Free_Mem_Chk.cpp index bc096f144d..f7900a0f35 100644 --- a/Marlin/M100_Free_Mem_Chk.cpp +++ b/Marlin/M100_Free_Mem_Chk.cpp @@ -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) diff --git a/Marlin/Marlin.h b/Marlin/Marlin.h index 4cdea59498..8819b3fb8f 100644 --- a/Marlin/Marlin.h +++ b/Marlin/Marlin.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/Marlin.ino b/Marlin/Marlin.ino index 5648e47fa9..7c4dd93014 100644 --- a/Marlin/Marlin.ino +++ b/Marlin/Marlin.ino @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * About Marlin * * This firmware is a mashup between Sprinter and grbl. diff --git a/Marlin/MarlinSerial.cpp b/Marlin/MarlinSerial.cpp index 2800cb04fd..e6362fc7c7 100644 --- a/Marlin/MarlinSerial.cpp +++ b/Marlin/MarlinSerial.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** HardwareSerial.cpp - Hardware serial library for Wiring Copyright (c) 2006 Nicholas Zambetti. All right reserved. diff --git a/Marlin/MarlinSerial.h b/Marlin/MarlinSerial.h index b884f242ae..6af14557e4 100644 --- a/Marlin/MarlinSerial.h +++ b/Marlin/MarlinSerial.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** HardwareSerial.h - Hardware serial library for Wiring Copyright (c) 2006 Nicholas Zambetti. All right reserved. diff --git a/Marlin/Marlin_main.cpp b/Marlin/Marlin_main.cpp index f9707daf11..edc36914c3 100644 --- a/Marlin/Marlin_main.cpp +++ b/Marlin/Marlin_main.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * * About Marlin * @@ -6618,7 +6618,7 @@ void clamp_to_software_endstops(float target[3]) { - sq(delta_tower3_x - cartesian[X_AXIS]) - sq(delta_tower3_y - cartesian[Y_AXIS]) ) + cartesian[Z_AXIS]; - /* + /** SERIAL_ECHOPGM("cartesian x="); SERIAL_ECHO(cartesian[X_AXIS]); SERIAL_ECHOPGM(" y="); SERIAL_ECHO(cartesian[Y_AXIS]); SERIAL_ECHOPGM(" z="); SERIAL_ECHOLN(cartesian[Z_AXIS]); @@ -6653,7 +6653,7 @@ void clamp_to_software_endstops(float target[3]) { delta[Y_AXIS] += offset; delta[Z_AXIS] += offset; - /* + /** SERIAL_ECHOPGM("grid_x="); SERIAL_ECHO(grid_x); SERIAL_ECHOPGM(" grid_y="); SERIAL_ECHO(grid_y); SERIAL_ECHOPGM(" floor_x="); SERIAL_ECHO(floor_x); @@ -7145,7 +7145,7 @@ void plan_arc( delta[Y_AXIS] = (SCARA_theta + SCARA_psi) * SCARA_RAD2DEG; // - equal to sub arm angle (inverted motor) delta[Z_AXIS] = cartesian[Z_AXIS]; - /* + /** SERIAL_ECHOPGM("cartesian x="); SERIAL_ECHO(cartesian[X_AXIS]); SERIAL_ECHOPGM(" y="); SERIAL_ECHO(cartesian[Y_AXIS]); SERIAL_ECHOPGM(" z="); SERIAL_ECHOLN(cartesian[Z_AXIS]); diff --git a/Marlin/SanityCheck.h b/Marlin/SanityCheck.h index 5204fce596..16df8fbbfb 100644 --- a/Marlin/SanityCheck.h +++ b/Marlin/SanityCheck.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/Sd2Card.cpp b/Marlin/Sd2Card.cpp index a97315c718..53935feb10 100644 --- a/Marlin/Sd2Card.cpp +++ b/Marlin/Sd2Card.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino Sd2Card Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/Sd2Card.h b/Marlin/Sd2Card.h index 5cc4c540ca..106890fefa 100644 --- a/Marlin/Sd2Card.h +++ b/Marlin/Sd2Card.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino Sd2Card Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/Sd2PinMap.h b/Marlin/Sd2PinMap.h index 0287bb187d..698e1c224d 100644 --- a/Marlin/Sd2PinMap.h +++ b/Marlin/Sd2PinMap.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2010 by William Greiman * diff --git a/Marlin/SdBaseFile.cpp b/Marlin/SdBaseFile.cpp index 0e5db7bea2..472a60a56a 100644 --- a/Marlin/SdBaseFile.cpp +++ b/Marlin/SdBaseFile.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdBaseFile.h b/Marlin/SdBaseFile.h index ef98535f71..2b912d2ed1 100644 --- a/Marlin/SdBaseFile.h +++ b/Marlin/SdBaseFile.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdFatConfig.h b/Marlin/SdFatConfig.h index d496ffd4f7..f9cb9fe140 100644 --- a/Marlin/SdFatConfig.h +++ b/Marlin/SdFatConfig.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdFatStructs.h b/Marlin/SdFatStructs.h index c7a761c4f8..3e989dea9d 100644 --- a/Marlin/SdFatStructs.h +++ b/Marlin/SdFatStructs.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * @@ -37,7 +37,7 @@ * \file * \brief FAT file structures */ -/* +/** * mostly from Microsoft document fatgen103.doc * http://www.microsoft.com/whdc/system/platform/firmware/fatgen.mspx */ diff --git a/Marlin/SdFatUtil.cpp b/Marlin/SdFatUtil.cpp index ba31299eae..48d91df682 100644 --- a/Marlin/SdFatUtil.cpp +++ b/Marlin/SdFatUtil.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2008 by William Greiman * diff --git a/Marlin/SdFatUtil.h b/Marlin/SdFatUtil.h index af4f45f8d6..93c633ca8b 100644 --- a/Marlin/SdFatUtil.h +++ b/Marlin/SdFatUtil.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2008 by William Greiman * diff --git a/Marlin/SdFile.cpp b/Marlin/SdFile.cpp index 81f63a4f4a..d5748efe24 100644 --- a/Marlin/SdFile.cpp +++ b/Marlin/SdFile.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdFile.h b/Marlin/SdFile.h index c15b210b41..53f38255cb 100644 --- a/Marlin/SdFile.h +++ b/Marlin/SdFile.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdInfo.h b/Marlin/SdInfo.h index 74cf65f268..f07dd6c017 100644 --- a/Marlin/SdInfo.h +++ b/Marlin/SdInfo.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino Sd2Card Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdVolume.cpp b/Marlin/SdVolume.cpp index c488f75197..e9c69dfc90 100644 --- a/Marlin/SdVolume.cpp +++ b/Marlin/SdVolume.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/SdVolume.h b/Marlin/SdVolume.h index 296d9955b9..990248d6a6 100644 --- a/Marlin/SdVolume.h +++ b/Marlin/SdVolume.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino SdFat Library * Copyright (C) 2009 by William Greiman * diff --git a/Marlin/blinkm.cpp b/Marlin/blinkm.cpp index c8d1c747ac..c495a5debd 100644 --- a/Marlin/blinkm.cpp +++ b/Marlin/blinkm.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * blinkm.cpp - Library for controlling a BlinkM over i2c * Created by Tim Koster, August 21 2013. */ diff --git a/Marlin/blinkm.h b/Marlin/blinkm.h index 0ecc441702..ed2ad79bb2 100644 --- a/Marlin/blinkm.h +++ b/Marlin/blinkm.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * blinkm.h - Library for controlling a BlinkM over i2c * Created by Tim Koster, August 21 2013. */ diff --git a/Marlin/boards.h b/Marlin/boards.h index 4395984ea7..6b297fcad2 100644 --- a/Marlin/boards.h +++ b/Marlin/boards.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/buzzer.cpp b/Marlin/buzzer.cpp index a53858cda5..776ea4dfae 100644 --- a/Marlin/buzzer.cpp +++ b/Marlin/buzzer.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/buzzer.h b/Marlin/buzzer.h index 307b18c9df..ec568ecd87 100644 --- a/Marlin/buzzer.h +++ b/Marlin/buzzer.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/cardreader.cpp b/Marlin/cardreader.cpp index 9eea93f538..bb2d6e1dd8 100644 --- a/Marlin/cardreader.cpp +++ b/Marlin/cardreader.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -245,7 +245,7 @@ void CardReader::initsd() { } workDir = root; curDir = &root; - /* + /** if (!workDir.openRoot(&volume)) { SERIAL_ECHOLNPGM(MSG_SD_WORKDIR_FAIL); } diff --git a/Marlin/cardreader.h b/Marlin/cardreader.h index cc8064ec58..8bd53e551f 100644 --- a/Marlin/cardreader.h +++ b/Marlin/cardreader.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/configuration_store.cpp b/Marlin/configuration_store.cpp index 240cac91db..d9929e10a1 100644 --- a/Marlin/configuration_store.cpp +++ b/Marlin/configuration_store.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * configuration_store.cpp * * Configuration and EEPROM storage diff --git a/Marlin/configuration_store.h b/Marlin/configuration_store.h index 1c68a323f9..2b2680607a 100644 --- a/Marlin/configuration_store.h +++ b/Marlin/configuration_store.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/dac_mcp4728.cpp b/Marlin/dac_mcp4728.cpp index e58772c2b1..3060e6e184 100644 --- a/Marlin/dac_mcp4728.cpp +++ b/Marlin/dac_mcp4728.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * mcp4728.cpp - Arduino library for MicroChip MCP4728 I2C D/A converter * * For implementation details, please take a look at the datasheet: @@ -30,18 +30,15 @@ * http://arduino.cc/forum/index.php/topic,51842.0.html */ - -/* _____PROJECT INCLUDES_____________________________________________________ */ #include "dac_mcp4728.h" #if ENABLED(DAC_STEPPER_CURRENT) -// Used Global variables uint16_t mcp4728_values[4]; -/* -Begin I2C, get current values (input register and eeprom) of mcp4728 -*/ +/** + * Begin I2C, get current values (input register and eeprom) of mcp4728 + */ void mcp4728_init() { Wire.begin(); Wire.requestFrom(int(DAC_DEV_ADDRESS), 24); @@ -58,19 +55,19 @@ void mcp4728_init() { } } -/* -Write input resister value to specified channel using fastwrite method. -Channel : 0-3, Values : 0-4095 -*/ +/** + * Write input resister value to specified channel using fastwrite method. + * Channel : 0-3, Values : 0-4095 + */ uint8_t mcp4728_analogWrite(uint8_t channel, uint16_t value) { mcp4728_values[channel] = value; return mcp4728_fastWrite(); } -/* -Write all input resistor values to EEPROM using SequencialWrite method. -This will update both input register and EEPROM value -This will also write current Vref, PowerDown, Gain settings to EEPROM -*/ +/** + * Write all input resistor values to EEPROM using SequencialWrite method. + * This will update both input register and EEPROM value + * This will also write current Vref, PowerDown, Gain settings to EEPROM + */ uint8_t mcp4728_eepromWrite() { Wire.beginTransmission(DAC_DEV_ADDRESS); Wire.send(SEQWRITE); @@ -81,31 +78,32 @@ uint8_t mcp4728_eepromWrite() { return Wire.endTransmission(); } -/* - Write Voltage reference setting to all input regiters -*/ +/** + * Write Voltage reference setting to all input regiters + */ uint8_t mcp4728_setVref_all(uint8_t value) { Wire.beginTransmission(DAC_DEV_ADDRESS); Wire.send(VREFWRITE | value << 3 | value << 2 | value << 1 | value); return Wire.endTransmission(); } -/* - Write Gain setting to all input regiters -*/ +/** + * Write Gain setting to all input regiters + */ uint8_t mcp4728_setGain_all(uint8_t value) { Wire.beginTransmission(DAC_DEV_ADDRESS); Wire.send(GAINWRITE | value << 3 | value << 2 | value << 1 | value); return Wire.endTransmission(); } -/* - Return Input Regiter value -*/ +/** + * Return Input Regiter value + */ uint16_t mcp4728_getValue(uint8_t channel) { return mcp4728_values[channel]; } -/* -// Steph: Might be useful in the future -// Return Vout +/** + * Steph: Might be useful in the future + * Return Vout + * uint16_t mcp4728_getVout(uint8_t channel) { uint32_t vref = 2048; uint32_t vOut = (vref * mcp4728_values[channel] * (_DAC_STEPPER_GAIN + 1)) / 4096; @@ -114,11 +112,11 @@ uint16_t mcp4728_getVout(uint8_t channel) { } */ -/* -FastWrite input register values - All DAC ouput update. refer to DATASHEET 5.6.1 -DAC Input and PowerDown bits update. -No EEPROM update -*/ +/** + * FastWrite input register values - All DAC ouput update. refer to DATASHEET 5.6.1 + * DAC Input and PowerDown bits update. + * No EEPROM update + */ uint8_t mcp4728_fastWrite() { Wire.beginTransmission(DAC_DEV_ADDRESS); for (uint8_t channel=0; channel <= 3; channel++) { @@ -128,9 +126,9 @@ uint8_t mcp4728_fastWrite() { return Wire.endTransmission(); } -/* -Common function for simple general commands -*/ +/** + * Common function for simple general commands + */ uint8_t mcp4728_simpleCommand(byte simpleCommand) { Wire.beginTransmission(GENERALCALL); Wire.send(simpleCommand); diff --git a/Marlin/dac_mcp4728.h b/Marlin/dac_mcp4728.h index 9dbe3299a0..e1739c5630 100644 --- a/Marlin/dac_mcp4728.h +++ b/Marlin/dac_mcp4728.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * Arduino library for MicroChip MCP4728 I2C D/A converter. */ diff --git a/Marlin/digipot_mcp4451.cpp b/Marlin/digipot_mcp4451.cpp index b32a4c3acd..771581341a 100644 --- a/Marlin/digipot_mcp4451.cpp +++ b/Marlin/digipot_mcp4451.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/dogm_bitmaps.h b/Marlin/dogm_bitmaps.h index bf8e8e35c8..db55a46a34 100644 --- a/Marlin/dogm_bitmaps.h +++ b/Marlin/dogm_bitmaps.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** * BitMap for splashscreen * Generated with: http://www.digole.com/tools/PicturetoC_Hex_converter.php * Please note that using the high-res version takes 402Bytes of PROGMEM. diff --git a/Marlin/dogm_font_data_6x9_marlin.h b/Marlin/dogm_font_data_6x9_marlin.h index 91a7d06a29..f298a6ac78 100644 --- a/Marlin/dogm_font_data_6x9_marlin.h +++ b/Marlin/dogm_font_data_6x9_marlin.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: -Misc-Fixed-Medium-R-Normal--9-90-75-75-C-60-ISO10646-1 Copyright: Public domain font. Share and enjoy. Capital A Height: 6, '1' Height: 6 diff --git a/Marlin/dogm_font_data_HD44780_C.h b/Marlin/dogm_font_data_HD44780_C.h index e2c8f7848c..21d4aaabe2 100644 --- a/Marlin/dogm_font_data_HD44780_C.h +++ b/Marlin/dogm_font_data_HD44780_C.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: HD44780_C v1.2 Copyright: A. Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_HD44780_J.h b/Marlin/dogm_font_data_HD44780_J.h index a4f22f7609..8b1b19847d 100644 --- a/Marlin/dogm_font_data_HD44780_J.h +++ b/Marlin/dogm_font_data_HD44780_J.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: HD44780_J Copyright: A. Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_HD44780_W.h b/Marlin/dogm_font_data_HD44780_W.h index 35852959a7..86b4bf4bff 100644 --- a/Marlin/dogm_font_data_HD44780_W.h +++ b/Marlin/dogm_font_data_HD44780_W.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: HD44780_W Copyright: A.Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_ISO10646_1.h b/Marlin/dogm_font_data_ISO10646_1.h index 0a47dd5e72..8ff40d054f 100644 --- a/Marlin/dogm_font_data_ISO10646_1.h +++ b/Marlin/dogm_font_data_ISO10646_1.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: ISO10646-1 Copyright: A.Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_ISO10646_5_Cyrillic.h b/Marlin/dogm_font_data_ISO10646_5_Cyrillic.h index b54c5cb37b..75e779fd0f 100644 --- a/Marlin/dogm_font_data_ISO10646_5_Cyrillic.h +++ b/Marlin/dogm_font_data_ISO10646_5_Cyrillic.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: ISO10646_5_Cyrillic Copyright: A. Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_ISO10646_CN.h b/Marlin/dogm_font_data_ISO10646_CN.h index 7c10372b33..11fdb2240b 100644 --- a/Marlin/dogm_font_data_ISO10646_CN.h +++ b/Marlin/dogm_font_data_ISO10646_CN.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: ISO10646_CN Copyright: A. Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_ISO10646_Kana.h b/Marlin/dogm_font_data_ISO10646_Kana.h index 39feaf40a0..372412cf0a 100644 --- a/Marlin/dogm_font_data_ISO10646_Kana.h +++ b/Marlin/dogm_font_data_ISO10646_Kana.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: ISO10646_Kana Copyright: A. Hardtung, public domain Capital A Height: 7, '1' Height: 7 diff --git a/Marlin/dogm_font_data_Marlin_symbols.h b/Marlin/dogm_font_data_Marlin_symbols.h index 976d3d2402..ad9b983b20 100644 --- a/Marlin/dogm_font_data_Marlin_symbols.h +++ b/Marlin/dogm_font_data_Marlin_symbols.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** Fontname: Marlin_symbols Copyright: Created with Fony 1.4.7 Capital A Height: 0, '1' Height: 0 diff --git a/Marlin/dogm_lcd_implementation.h b/Marlin/dogm_lcd_implementation.h index 1637d20d74..107b8608f2 100644 --- a/Marlin/dogm_lcd_implementation.h +++ b/Marlin/dogm_lcd_implementation.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/example_configurations/Felix/Configuration.h b/Marlin/example_configurations/Felix/Configuration.h index 597014d69b..e7c7a30b6c 100644 --- a/Marlin/example_configurations/Felix/Configuration.h +++ b/Marlin/example_configurations/Felix/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/Felix/Configuration_DUAL.h b/Marlin/example_configurations/Felix/Configuration_DUAL.h index e219face85..9ef89040c0 100644 --- a/Marlin/example_configurations/Felix/Configuration_DUAL.h +++ b/Marlin/example_configurations/Felix/Configuration_DUAL.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/Felix/Configuration_adv.h b/Marlin/example_configurations/Felix/Configuration_adv.h index 9e95fe5c24..216d164158 100644 --- a/Marlin/example_configurations/Felix/Configuration_adv.h +++ b/Marlin/example_configurations/Felix/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Hephestos/Configuration.h b/Marlin/example_configurations/Hephestos/Configuration.h index 65918ea89e..3f90aa4ec8 100644 --- a/Marlin/example_configurations/Hephestos/Configuration.h +++ b/Marlin/example_configurations/Hephestos/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/Hephestos/Configuration_adv.h b/Marlin/example_configurations/Hephestos/Configuration_adv.h index f828f184eb..2bd84d0b46 100644 --- a/Marlin/example_configurations/Hephestos/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/Hephestos_2/Configuration.h b/Marlin/example_configurations/Hephestos_2/Configuration.h index 94c6c3138d..5b56789d40 100644 --- a/Marlin/example_configurations/Hephestos_2/Configuration.h +++ b/Marlin/example_configurations/Hephestos_2/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h index fc85677241..c3ac27d7d6 100644 --- a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/K8200/Configuration.h b/Marlin/example_configurations/K8200/Configuration.h index 06c7ca0855..1c6090c001 100644 --- a/Marlin/example_configurations/K8200/Configuration.h +++ b/Marlin/example_configurations/K8200/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,11 +20,28 @@ * */ -// Sample configuration file for Vellemann K8200 -// tested on K8200 with VM8201 (Display) -// and Arduino 1.6.8 (Mac) by @CONSULitAS, 2016-02-21 -// https://github.com/CONSULitAS/Marlin-K8200/archive/K8200_stable_2016-02-21.zip +/** + * Sample configuration file for Vellemann K8200 + * tested on K8200 with VM8201 (Display) + * and Arduino 1.6.8 (Mac) by @CONSULitAS, 2016-02-21 + * https://github.com/CONSULitAS/Marlin-K8200/archive/K8200_stable_2016-02-21.zip + */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -34,8 +51,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -43,11 +62,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/K8200/Configuration_adv.h b/Marlin/example_configurations/K8200/Configuration_adv.h index c90c93ff02..3a58710a5a 100644 --- a/Marlin/example_configurations/K8200/Configuration_adv.h +++ b/Marlin/example_configurations/K8200/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -25,6 +25,17 @@ // and Arduino 1.6.8 (Mac) by @CONSULitAS, 2016-02-21 // https://github.com/CONSULitAS/Marlin-K8200/archive/K8200_stable_2016-02-21.zip + +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h b/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h index 0ed4702575..b2fb63a2b4 100644 --- a/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h +++ b/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/RigidBot/Configuration.h b/Marlin/example_configurations/RigidBot/Configuration.h index caea2418ef..8241759332 100644 --- a/Marlin/example_configurations/RigidBot/Configuration.h +++ b/Marlin/example_configurations/RigidBot/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/RigidBot/Configuration_adv.h b/Marlin/example_configurations/RigidBot/Configuration_adv.h index 316881e75b..23233e5107 100644 --- a/Marlin/example_configurations/RigidBot/Configuration_adv.h +++ b/Marlin/example_configurations/RigidBot/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/SCARA/Configuration.h b/Marlin/example_configurations/SCARA/Configuration.h index 6eb99c15fb..2e8bd5c7b7 100644 --- a/Marlin/example_configurations/SCARA/Configuration.h +++ b/Marlin/example_configurations/SCARA/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/SCARA/Configuration_adv.h b/Marlin/example_configurations/SCARA/Configuration_adv.h index ecf4b6503b..a8ee979d2e 100644 --- a/Marlin/example_configurations/SCARA/Configuration_adv.h +++ b/Marlin/example_configurations/SCARA/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/TAZ4/Configuration.h b/Marlin/example_configurations/TAZ4/Configuration.h index 0515ebca61..fc4c0c7574 100644 --- a/Marlin/example_configurations/TAZ4/Configuration.h +++ b/Marlin/example_configurations/TAZ4/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/TAZ4/Configuration_adv.h b/Marlin/example_configurations/TAZ4/Configuration_adv.h index 6a64d03ada..70d7db6101 100644 --- a/Marlin/example_configurations/TAZ4/Configuration_adv.h +++ b/Marlin/example_configurations/TAZ4/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/WITBOX/Configuration.h b/Marlin/example_configurations/WITBOX/Configuration.h index 5db9f21429..5a0a5ec3a4 100644 --- a/Marlin/example_configurations/WITBOX/Configuration.h +++ b/Marlin/example_configurations/WITBOX/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/WITBOX/Configuration_adv.h b/Marlin/example_configurations/WITBOX/Configuration_adv.h index f828f184eb..2bd84d0b46 100644 --- a/Marlin/example_configurations/WITBOX/Configuration_adv.h +++ b/Marlin/example_configurations/WITBOX/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/adafruit/ST7565/Configuration.h b/Marlin/example_configurations/adafruit/ST7565/Configuration.h index ba7c699a1f..3dc5017fa9 100644 --- a/Marlin/example_configurations/adafruit/ST7565/Configuration.h +++ b/Marlin/example_configurations/adafruit/ST7565/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/biv2.5/Configuration.h b/Marlin/example_configurations/delta/biv2.5/Configuration.h index 2f339cbfa2..3c77b9cf00 100644 --- a/Marlin/example_configurations/delta/biv2.5/Configuration.h +++ b/Marlin/example_configurations/delta/biv2.5/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h b/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h index e0f3e04b7f..ea7d782e2f 100644 --- a/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h +++ b/Marlin/example_configurations/delta/biv2.5/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/generic/Configuration.h b/Marlin/example_configurations/delta/generic/Configuration.h index 687f9b0b03..42452f5132 100644 --- a/Marlin/example_configurations/delta/generic/Configuration.h +++ b/Marlin/example_configurations/delta/generic/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/generic/Configuration_adv.h b/Marlin/example_configurations/delta/generic/Configuration_adv.h index 7b21d45516..c50f7e8bda 100644 --- a/Marlin/example_configurations/delta/generic/Configuration_adv.h +++ b/Marlin/example_configurations/delta/generic/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration.h b/Marlin/example_configurations/delta/kossel_mini/Configuration.h index 41132655d1..21a50d3f5b 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h index 702a1a3779..436d8c228f 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_pro/Configuration.h b/Marlin/example_configurations/delta/kossel_pro/Configuration.h index ea86961639..3e533a4a4c 100644 --- a/Marlin/example_configurations/delta/kossel_pro/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_pro/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,10 +20,27 @@ * */ -// Example configuration file for OpenBeam Kossel Pro -// tested on 2015-05-19 by @Wackerbarth -// using Arduino 1.6.5 (Mac) +/** + * Example configuration file for OpenBeam Kossel Pro + * tested on 2015-05-19 by @Wackerbarth + * using Arduino 1.6.5 (Mac) + */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -33,8 +50,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -42,11 +61,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h index 58e0c710bf..f7cb980b42 100644 --- a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -24,6 +24,17 @@ // tested on 2015-05-19 by @Wackerbarth // using Arduino 1.6.5 (Mac) + +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/delta/kossel_xl/Configuration.h b/Marlin/example_configurations/delta/kossel_xl/Configuration.h index 9a508859ad..ae8cdf6fef 100644 --- a/Marlin/example_configurations/delta/kossel_xl/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_xl/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h index 1378755416..8fd808419a 100644 --- a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/makibox/Configuration.h b/Marlin/example_configurations/makibox/Configuration.h index 5854acd99e..7ce56ede05 100644 --- a/Marlin/example_configurations/makibox/Configuration.h +++ b/Marlin/example_configurations/makibox/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/makibox/Configuration_adv.h b/Marlin/example_configurations/makibox/Configuration_adv.h index 1d4bc409f6..8ec4d870a8 100644 --- a/Marlin/example_configurations/makibox/Configuration_adv.h +++ b/Marlin/example_configurations/makibox/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration.h b/Marlin/example_configurations/tvrrug/Round2/Configuration.h index 8ababd37c2..b1d212b6c6 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,21 @@ * */ +/** + * Configuration.h + * + * Basic settings such as: + * + * - Type of electronics + * - Type of temperature sensor + * - Printer geometry + * - Endstop configuration + * - LCD controller + * - Extra features + * + * Advanced settings can be found in Configuration_adv.h + * + */ #ifndef CONFIGURATION_H #define CONFIGURATION_H @@ -29,8 +44,10 @@ //=========================================================================== //============================= Getting Started ============================= //=========================================================================== -/* -Here are some standard links for getting your machine calibrated: + +/** + * Here are some standard links for getting your machine calibrated: + * * http://reprap.org/wiki/Calibration * http://youtu.be/wAL9d7FgInk * http://calculator.josefprusa.cz @@ -38,11 +55,7 @@ Here are some standard links for getting your machine calibrated: * http://www.thingiverse.com/thing:5573 * https://sites.google.com/site/repraplogphase/calibration-of-your-reprap * http://www.thingiverse.com/thing:298812 -*/ - -// This configuration file contains the basic settings. -// Advanced settings can be found in Configuration_adv.h -// BASIC SETTINGS: select your board type, temperature sensor type, axis scaling, and endstop configuration + */ //=========================================================================== //============================= DELTA Printer =============================== diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h index 0409216da5..f8630f0aec 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,6 +20,16 @@ * */ +/** + * Configuration_adv.h + * + * Advanced settings. + * Only change these if you know exactly what you're doing. + * Some of these settings can damage your printer if improperly set! + * + * Basic settings can be found in Configuration.h + * + */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H diff --git a/Marlin/fastio.h b/Marlin/fastio.h index 053113f997..fe8fa70e95 100644 --- a/Marlin/fastio.h +++ b/Marlin/fastio.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** This code contributed by Triffid_Hunter and modified by Kliment why double up on these macros? see http://gcc.gnu.org/onlinedocs/cpp/Stringification.html */ @@ -30,7 +30,7 @@ #include -/* +/** utility functions */ @@ -38,7 +38,7 @@ #define MASK(PIN) (1 << PIN) #endif -/* +/** magic I/O routines now you can simply SET_OUTPUT(STEP); WRITE(STEP, 1); WRITE(STEP, 0); */ @@ -107,7 +107,7 @@ // Shorthand #define OUT_WRITE(IO, v) { SET_OUTPUT(IO); WRITE(IO, v); } -/* +/** ports and functions added as necessary or if I feel like it- not a comprehensive list! @@ -138,7 +138,7 @@ #define DEBUG_LED AIO5 - /* + /** pins */ @@ -477,7 +477,7 @@ #define OC2B DIO14 #define DEBUG_LED DIO0 - /* + /** pins */ @@ -986,7 +986,7 @@ // change for your board #define DEBUG_LED DIO21 - /* + /** pins */ #define DIO0_PIN PINE0 @@ -2056,7 +2056,7 @@ // change for your board #define DEBUG_LED DIO31 /* led D5 red */ - /* + /** pins */ @@ -2698,7 +2698,7 @@ #else // AT90USBxx_TEENSYPP_ASSIGNMENTS -- Use Teensyduino Teensy++2.0 assignments. - /* + /** AT90USB 51 50 49 48 47 46 45 44 10 11 12 13 14 15 16 17 35 36 37 38 39 40 41 42 25 26 27 28 29 30 31 32 33 34 43 09 18 19 01 02 61 60 59 58 57 56 55 54 Port A0 A1 A2 A3 A4 A5 A6 A7 B0 B1 B2 B3 B4 B5 B6 B7 C0 C1 C2 C3 C4 C5 C6 C7 D0 D1 D2 D3 D4 D5 D6 D7 E0 E1 E2 E3 E4 E5 E6 E7 F0 F1 F2 F3 F4 F5 F6 F7 @@ -3373,7 +3373,7 @@ // change for your board #define DEBUG_LED DIO46 - /* + /** pins */ #define DIO0_PIN PINE0 diff --git a/Marlin/language.h b/Marlin/language.h index f3ca13f39e..1b82ec314c 100644 --- a/Marlin/language.h +++ b/Marlin/language.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_an.h b/Marlin/language_an.h index cf7a8a9e5c..ab93671dc0 100644 --- a/Marlin/language_an.h +++ b/Marlin/language_an.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_bg.h b/Marlin/language_bg.h index fadef863c8..c6007dba36 100644 --- a/Marlin/language_bg.h +++ b/Marlin/language_bg.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_ca.h b/Marlin/language_ca.h index d7db26d32e..f08e29e32b 100644 --- a/Marlin/language_ca.h +++ b/Marlin/language_ca.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_cn.h b/Marlin/language_cn.h index ed386493c3..e6a0ccf0af 100644 --- a/Marlin/language_cn.h +++ b/Marlin/language_cn.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_cz.h b/Marlin/language_cz.h index f7464d221d..6555aa01ea 100644 --- a/Marlin/language_cz.h +++ b/Marlin/language_cz.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_da.h b/Marlin/language_da.h index da0d6bdc64..e47fd1c8fa 100644 --- a/Marlin/language_da.h +++ b/Marlin/language_da.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_de.h b/Marlin/language_de.h index 254034665d..3d791e2d35 100644 --- a/Marlin/language_de.h +++ b/Marlin/language_de.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_en.h b/Marlin/language_en.h index 38cc8957e8..b4eb6d5cdf 100644 --- a/Marlin/language_en.h +++ b/Marlin/language_en.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_es.h b/Marlin/language_es.h index 2401e618d5..a8c4fc803c 100644 --- a/Marlin/language_es.h +++ b/Marlin/language_es.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_eu.h b/Marlin/language_eu.h index 0223f144c6..28e0e0c034 100644 --- a/Marlin/language_eu.h +++ b/Marlin/language_eu.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_fi.h b/Marlin/language_fi.h index 8d23775c5b..b6f7de6fd8 100644 --- a/Marlin/language_fi.h +++ b/Marlin/language_fi.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_fr.h b/Marlin/language_fr.h index be4fce7656..11aaf95754 100644 --- a/Marlin/language_fr.h +++ b/Marlin/language_fr.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_gl.h b/Marlin/language_gl.h index c26e19c328..2a15935309 100644 --- a/Marlin/language_gl.h +++ b/Marlin/language_gl.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_it.h b/Marlin/language_it.h index 1056554c19..23ad7c6c56 100644 --- a/Marlin/language_it.h +++ b/Marlin/language_it.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_kana.h b/Marlin/language_kana.h index 40bfd96efa..fca13e9294 100644 --- a/Marlin/language_kana.h +++ b/Marlin/language_kana.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_kana_utf8.h b/Marlin/language_kana_utf8.h index 75763318a9..4ca47a8e73 100644 --- a/Marlin/language_kana_utf8.h +++ b/Marlin/language_kana_utf8.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_nl.h b/Marlin/language_nl.h index 34a23510a8..27aefee013 100644 --- a/Marlin/language_nl.h +++ b/Marlin/language_nl.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_pl.h b/Marlin/language_pl.h index f5d63a8d08..37586f53a2 100644 --- a/Marlin/language_pl.h +++ b/Marlin/language_pl.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_pt-br.h b/Marlin/language_pt-br.h index 8a6567bbff..3e882635fc 100644 --- a/Marlin/language_pt-br.h +++ b/Marlin/language_pt-br.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_pt-br_utf8.h b/Marlin/language_pt-br_utf8.h index 5f08e846e3..7b6639bd04 100644 --- a/Marlin/language_pt-br_utf8.h +++ b/Marlin/language_pt-br_utf8.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_pt.h b/Marlin/language_pt.h index eb3cb9dd84..5070c93eac 100644 --- a/Marlin/language_pt.h +++ b/Marlin/language_pt.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_pt_utf8.h b/Marlin/language_pt_utf8.h index 2cc7cc2db9..64da9645d0 100644 --- a/Marlin/language_pt_utf8.h +++ b/Marlin/language_pt_utf8.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_ru.h b/Marlin/language_ru.h index d2076b3a7a..fe04c03aae 100644 --- a/Marlin/language_ru.h +++ b/Marlin/language_ru.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/language_test.h b/Marlin/language_test.h index f8ebacaa98..3444ee5029 100644 --- a/Marlin/language_test.h +++ b/Marlin/language_test.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/macros.h b/Marlin/macros.h index 4318a4ddab..966fc48d02 100644 --- a/Marlin/macros.h +++ b/Marlin/macros.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/mesh_bed_leveling.cpp b/Marlin/mesh_bed_leveling.cpp index c6d168ae3b..462c6c6866 100644 --- a/Marlin/mesh_bed_leveling.cpp +++ b/Marlin/mesh_bed_leveling.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/mesh_bed_leveling.h b/Marlin/mesh_bed_leveling.h index f9a8e72746..d531ff5162 100644 --- a/Marlin/mesh_bed_leveling.h +++ b/Marlin/mesh_bed_leveling.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins.h b/Marlin/pins.h index b4f1c39782..b116364628 100644 --- a/Marlin/pins.h +++ b/Marlin/pins.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_3DRAG.h b/Marlin/pins_3DRAG.h index 1c8997ace0..e3175a2402 100644 --- a/Marlin/pins_3DRAG.h +++ b/Marlin/pins_3DRAG.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_5DPRINT.h b/Marlin/pins_5DPRINT.h index 425f46ced2..14a5d4d7d5 100644 --- a/Marlin/pins_5DPRINT.h +++ b/Marlin/pins_5DPRINT.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_99.h b/Marlin/pins_99.h index 4ac464b805..1b050573f6 100644 --- a/Marlin/pins_99.h +++ b/Marlin/pins_99.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_A4JP.h b/Marlin/pins_A4JP.h index 19c3a96a3f..2e36db5957 100644 --- a/Marlin/pins_A4JP.h +++ b/Marlin/pins_A4JP.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_AZTEEG_X1.h b/Marlin/pins_AZTEEG_X1.h index 12bb7caf91..21bb491f5b 100644 --- a/Marlin/pins_AZTEEG_X1.h +++ b/Marlin/pins_AZTEEG_X1.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_AZTEEG_X3.h b/Marlin/pins_AZTEEG_X3.h index fe9bcadf12..2668d09134 100644 --- a/Marlin/pins_AZTEEG_X3.h +++ b/Marlin/pins_AZTEEG_X3.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_AZTEEG_X3_PRO.h b/Marlin/pins_AZTEEG_X3_PRO.h index 2a6b2fa792..a184ec2b97 100644 --- a/Marlin/pins_AZTEEG_X3_PRO.h +++ b/Marlin/pins_AZTEEG_X3_PRO.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_BAM_DICE_DUE.h b/Marlin/pins_BAM_DICE_DUE.h index 3f28f232c1..355daf5c1d 100644 --- a/Marlin/pins_BAM_DICE_DUE.h +++ b/Marlin/pins_BAM_DICE_DUE.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_BQ_ZUM_MEGA_3D.h b/Marlin/pins_BQ_ZUM_MEGA_3D.h index f73375ed9d..d8ea114613 100644 --- a/Marlin/pins_BQ_ZUM_MEGA_3D.h +++ b/Marlin/pins_BQ_ZUM_MEGA_3D.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_BRAINWAVE.h b/Marlin/pins_BRAINWAVE.h index 03acdaf59a..a02b6515f4 100644 --- a/Marlin/pins_BRAINWAVE.h +++ b/Marlin/pins_BRAINWAVE.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_BRAINWAVE_PRO.h b/Marlin/pins_BRAINWAVE_PRO.h index 27cdb780c9..c79f04eb65 100644 --- a/Marlin/pins_BRAINWAVE_PRO.h +++ b/Marlin/pins_BRAINWAVE_PRO.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_CHEAPTRONIC.h b/Marlin/pins_CHEAPTRONIC.h index 270297f146..1bbd979520 100644 --- a/Marlin/pins_CHEAPTRONIC.h +++ b/Marlin/pins_CHEAPTRONIC.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_ELEFU_3.h b/Marlin/pins_ELEFU_3.h index 45444aa9ce..23f8b944f1 100644 --- a/Marlin/pins_ELEFU_3.h +++ b/Marlin/pins_ELEFU_3.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_FELIX2.h b/Marlin/pins_FELIX2.h index 9287fbd41b..79d8332ada 100644 --- a/Marlin/pins_FELIX2.h +++ b/Marlin/pins_FELIX2.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN3_MONOLITHIC.h b/Marlin/pins_GEN3_MONOLITHIC.h index ca876ff800..ba61fd2a68 100644 --- a/Marlin/pins_GEN3_MONOLITHIC.h +++ b/Marlin/pins_GEN3_MONOLITHIC.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN3_PLUS.h b/Marlin/pins_GEN3_PLUS.h index eb3a7f1582..15241bfb53 100644 --- a/Marlin/pins_GEN3_PLUS.h +++ b/Marlin/pins_GEN3_PLUS.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN6.h b/Marlin/pins_GEN6.h index 042095e486..6d1ce468da 100644 --- a/Marlin/pins_GEN6.h +++ b/Marlin/pins_GEN6.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN6_DELUXE.h b/Marlin/pins_GEN6_DELUXE.h index 647dcd20ed..718f517c6b 100644 --- a/Marlin/pins_GEN6_DELUXE.h +++ b/Marlin/pins_GEN6_DELUXE.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN7_12.h b/Marlin/pins_GEN7_12.h index 488f6402c4..0c23c06482 100644 --- a/Marlin/pins_GEN7_12.h +++ b/Marlin/pins_GEN7_12.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN7_13.h b/Marlin/pins_GEN7_13.h index 9a721e21dc..5887aeca8e 100644 --- a/Marlin/pins_GEN7_13.h +++ b/Marlin/pins_GEN7_13.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN7_14.h b/Marlin/pins_GEN7_14.h index 697bd806b4..04a4fce1ac 100644 --- a/Marlin/pins_GEN7_14.h +++ b/Marlin/pins_GEN7_14.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_GEN7_CUSTOM.h b/Marlin/pins_GEN7_CUSTOM.h index dcaa3264ef..9150a41b9e 100644 --- a/Marlin/pins_GEN7_CUSTOM.h +++ b/Marlin/pins_GEN7_CUSTOM.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_K8200.h b/Marlin/pins_K8200.h index e6d7ba436d..6aab9caed2 100644 --- a/Marlin/pins_K8200.h +++ b/Marlin/pins_K8200.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_LEAPFROG.h b/Marlin/pins_LEAPFROG.h index 8366b6971c..8d1a2401a9 100644 --- a/Marlin/pins_LEAPFROG.h +++ b/Marlin/pins_LEAPFROG.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MEGACONTROLLER.h b/Marlin/pins_MEGACONTROLLER.h index c58a28d65c..61cd91be01 100644 --- a/Marlin/pins_MEGACONTROLLER.h +++ b/Marlin/pins_MEGACONTROLLER.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MEGATRONICS.h b/Marlin/pins_MEGATRONICS.h index 99d87b0a00..e25cf8a55b 100644 --- a/Marlin/pins_MEGATRONICS.h +++ b/Marlin/pins_MEGATRONICS.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MEGATRONICS_2.h b/Marlin/pins_MEGATRONICS_2.h index ea1683d6eb..186f154275 100644 --- a/Marlin/pins_MEGATRONICS_2.h +++ b/Marlin/pins_MEGATRONICS_2.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MEGATRONICS_3.h b/Marlin/pins_MEGATRONICS_3.h index 3a7c378898..c60f3c6339 100644 --- a/Marlin/pins_MEGATRONICS_3.h +++ b/Marlin/pins_MEGATRONICS_3.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MELZI.h b/Marlin/pins_MELZI.h index 96de98b237..dae033bf89 100644 --- a/Marlin/pins_MELZI.h +++ b/Marlin/pins_MELZI.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MELZI_MAKR3D.h b/Marlin/pins_MELZI_MAKR3D.h index d878f6f4ec..fe77e27bc9 100644 --- a/Marlin/pins_MELZI_MAKR3D.h +++ b/Marlin/pins_MELZI_MAKR3D.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MINIRAMBO.h b/Marlin/pins_MINIRAMBO.h index 2a96d5ec95..a67dd9c3a8 100644 --- a/Marlin/pins_MINIRAMBO.h +++ b/Marlin/pins_MINIRAMBO.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MINITRONICS.h b/Marlin/pins_MINITRONICS.h index 5e4d122496..8bd7b5fc1e 100644 --- a/Marlin/pins_MINITRONICS.h +++ b/Marlin/pins_MINITRONICS.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_MKS_BASE.h b/Marlin/pins_MKS_BASE.h index fa2bfb60e2..5ca8e05b92 100644 --- a/Marlin/pins_MKS_BASE.h +++ b/Marlin/pins_MKS_BASE.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_OMCA.h b/Marlin/pins_OMCA.h index 02d3b7c244..e98439608f 100644 --- a/Marlin/pins_OMCA.h +++ b/Marlin/pins_OMCA.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_OMCA_A.h b/Marlin/pins_OMCA_A.h index 49405edcfe..147006de75 100644 --- a/Marlin/pins_OMCA_A.h +++ b/Marlin/pins_OMCA_A.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_PRINTRBOARD.h b/Marlin/pins_PRINTRBOARD.h index 72f73b5335..8933517107 100644 --- a/Marlin/pins_PRINTRBOARD.h +++ b/Marlin/pins_PRINTRBOARD.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_PRINTRBOARD_REVF.h b/Marlin/pins_PRINTRBOARD_REVF.h index 3b3dab579c..d0c6fdb9ed 100644 --- a/Marlin/pins_PRINTRBOARD_REVF.h +++ b/Marlin/pins_PRINTRBOARD_REVF.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMBO.h b/Marlin/pins_RAMBO.h index bb2d283ae3..b748693167 100644 --- a/Marlin/pins_RAMBO.h +++ b/Marlin/pins_RAMBO.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMPS_13.h b/Marlin/pins_RAMPS_13.h index f4b10da0f8..5655f35a14 100644 --- a/Marlin/pins_RAMPS_13.h +++ b/Marlin/pins_RAMPS_13.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMPS_13_EFB.h b/Marlin/pins_RAMPS_13_EFB.h index 9ba72ef55d..e0bea37e7f 100644 --- a/Marlin/pins_RAMPS_13_EFB.h +++ b/Marlin/pins_RAMPS_13_EFB.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMPS_14.h b/Marlin/pins_RAMPS_14.h index cfd900d109..9354cc2453 100644 --- a/Marlin/pins_RAMPS_14.h +++ b/Marlin/pins_RAMPS_14.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMPS_14_EFB.h b/Marlin/pins_RAMPS_14_EFB.h index ccfda8e9f3..a43e4d2278 100644 --- a/Marlin/pins_RAMPS_14_EFB.h +++ b/Marlin/pins_RAMPS_14_EFB.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RAMPS_OLD.h b/Marlin/pins_RAMPS_OLD.h index 7f7bf3ed49..25193c8ed8 100644 --- a/Marlin/pins_RAMPS_OLD.h +++ b/Marlin/pins_RAMPS_OLD.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RIGIDBOARD.h b/Marlin/pins_RIGIDBOARD.h index 411a2884a4..69ce67d87f 100644 --- a/Marlin/pins_RIGIDBOARD.h +++ b/Marlin/pins_RIGIDBOARD.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_RUMBA.h b/Marlin/pins_RUMBA.h index a594fbd891..e2d1e209fb 100644 --- a/Marlin/pins_RUMBA.h +++ b/Marlin/pins_RUMBA.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_SANGUINOLOLU_11.h b/Marlin/pins_SANGUINOLOLU_11.h index b219566ec1..d848548787 100644 --- a/Marlin/pins_SANGUINOLOLU_11.h +++ b/Marlin/pins_SANGUINOLOLU_11.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_SANGUINOLOLU_12.h b/Marlin/pins_SANGUINOLOLU_12.h index 2a25ad1103..84d86275e9 100644 --- a/Marlin/pins_SANGUINOLOLU_12.h +++ b/Marlin/pins_SANGUINOLOLU_12.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_SAV_MKI.h b/Marlin/pins_SAV_MKI.h index 3807dc25b2..4c14fa6e2d 100644 --- a/Marlin/pins_SAV_MKI.h +++ b/Marlin/pins_SAV_MKI.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_SETHI.h b/Marlin/pins_SETHI.h index 353e1a2be3..e16b45cea2 100644 --- a/Marlin/pins_SETHI.h +++ b/Marlin/pins_SETHI.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_STB_11.h b/Marlin/pins_STB_11.h index 487c73453f..9ca93a3f70 100644 --- a/Marlin/pins_STB_11.h +++ b/Marlin/pins_STB_11.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_TEENSY2.h b/Marlin/pins_TEENSY2.h index b75606871b..eb27ae97d6 100644 --- a/Marlin/pins_TEENSY2.h +++ b/Marlin/pins_TEENSY2.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_TEENSYLU.h b/Marlin/pins_TEENSYLU.h index 0538fb95ba..ea1492429b 100644 --- a/Marlin/pins_TEENSYLU.h +++ b/Marlin/pins_TEENSYLU.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_ULTIMAIN_2.h b/Marlin/pins_ULTIMAIN_2.h index 62b601ff8d..f4635b3987 100644 --- a/Marlin/pins_ULTIMAIN_2.h +++ b/Marlin/pins_ULTIMAIN_2.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_ULTIMAKER.h b/Marlin/pins_ULTIMAKER.h index 259fca9fc6..36feb6e021 100644 --- a/Marlin/pins_ULTIMAKER.h +++ b/Marlin/pins_ULTIMAKER.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/pins_ULTIMAKER_OLD.h b/Marlin/pins_ULTIMAKER_OLD.h index 7b7b8d9f89..d08b5bd271 100644 --- a/Marlin/pins_ULTIMAKER_OLD.h +++ b/Marlin/pins_ULTIMAKER_OLD.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/planner.cpp b/Marlin/planner.cpp index b14903c29f..6bc35627a1 100644 --- a/Marlin/planner.cpp +++ b/Marlin/planner.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -1062,7 +1062,7 @@ float junction_deviation = 0.1; block->advance = advance; block->advance_rate = acc_dist ? advance / (float)acc_dist : 0; } - /* + /** SERIAL_ECHO_START; SERIAL_ECHOPGM("advance :"); SERIAL_ECHO(block->advance/256.0); diff --git a/Marlin/planner.h b/Marlin/planner.h index eca5535542..dd724424b6 100644 --- a/Marlin/planner.h +++ b/Marlin/planner.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** planner.h - buffers movement commands and manages the acceleration profile plan Part of Grbl diff --git a/Marlin/qr_solve.cpp b/Marlin/qr_solve.cpp index 202de7ce74..ddafb005ea 100644 --- a/Marlin/qr_solve.cpp +++ b/Marlin/qr_solve.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -32,7 +32,7 @@ int i4_min(int i1, int i2) /******************************************************************************/ -/* +/** Purpose: I4_MIN returns the smaller of two I4's. @@ -62,7 +62,7 @@ int i4_min(int i1, int i2) double r8_epsilon(void) /******************************************************************************/ -/* +/** Purpose: R8_EPSILON returns the R8 round off unit. @@ -99,7 +99,7 @@ double r8_epsilon(void) double r8_max(double x, double y) /******************************************************************************/ -/* +/** Purpose: R8_MAX returns the maximum of two R8's. @@ -129,7 +129,7 @@ double r8_max(double x, double y) double r8_abs(double x) /******************************************************************************/ -/* +/** Purpose: R8_ABS returns the absolute value of an R8. @@ -159,7 +159,7 @@ double r8_abs(double x) double r8_sign(double x) /******************************************************************************/ -/* +/** Purpose: R8_SIGN returns the sign of an R8. @@ -189,7 +189,7 @@ double r8_sign(double x) double r8mat_amax(int m, int n, double a[]) /******************************************************************************/ -/* +/** Purpose: R8MAT_AMAX returns the maximum absolute value entry of an R8MAT. @@ -234,7 +234,7 @@ double r8mat_amax(int m, int n, double a[]) void r8mat_copy(double a2[], int m, int n, double a1[]) /******************************************************************************/ -/* +/** Purpose: R8MAT_COPY_NEW copies one R8MAT to a "new" R8MAT. @@ -276,7 +276,7 @@ void r8mat_copy(double a2[], int m, int n, double a1[]) void daxpy(int n, double da, double dx[], int incx, double dy[], int incy) /******************************************************************************/ -/* +/** Purpose: DAXPY computes constant times a vector plus a vector. @@ -328,7 +328,7 @@ void daxpy(int n, double da, double dx[], int incx, double dy[], int incy) if (n <= 0 || da == 0.0) return; int i, ix, iy, m; - /* + /** Code for unequal increments or equal increments not equal to 1. */ @@ -347,7 +347,7 @@ void daxpy(int n, double da, double dx[], int incx, double dy[], int incy) iy = iy + incy; } } - /* + /** Code for both increments equal to 1. */ else { @@ -367,7 +367,7 @@ void daxpy(int n, double da, double dx[], int incx, double dy[], int incy) double ddot(int n, double dx[], int incx, double dy[], int incy) /******************************************************************************/ -/* +/** Purpose: DDOT forms the dot product of two vectors. @@ -422,7 +422,7 @@ double ddot(int n, double dx[], int incx, double dy[], int incy) int i, m; double dtemp = 0.0; - /* + /** Code for unequal increments or equal increments not equal to 1. */ @@ -435,7 +435,7 @@ double ddot(int n, double dx[], int incx, double dy[], int incy) iy = iy + incy; } } - /* + /** Code for both increments equal to 1. */ else { @@ -457,7 +457,7 @@ double ddot(int n, double dx[], int incx, double dy[], int incy) double dnrm2(int n, double x[], int incx) /******************************************************************************/ -/* +/** Purpose: DNRM2 returns the euclidean norm of a vector. @@ -531,7 +531,7 @@ void dqrank(double a[], int lda, int m, int n, double tol, int* kr, int jpvt[], double qraux[]) /******************************************************************************/ -/* +/** Purpose: DQRANK computes the QR factorization of a rectangular matrix. @@ -625,7 +625,7 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], double work[], int job) /******************************************************************************/ -/* +/** Purpose: DQRDC computes the QR factorization of a real rectangular matrix. @@ -709,7 +709,7 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], double maxnrm, nrmxl, t, tt; int pl = 1, pu = 0; - /* + /** If pivoting is requested, rearrange the columns. */ if (job != 0) { @@ -738,19 +738,19 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], } } } - /* + /** Compute the norms of the free columns. */ for (j = pl; j <= pu; j++) qraux[j - 1] = dnrm2(n, a + 0 + (j - 1) * lda, 1); for (j = pl; j <= pu; j++) work[j - 1] = qraux[j - 1]; - /* + /** Perform the Householder reduction of A. */ lup = i4_min(n, p); for (int l = 1; l <= lup; l++) { - /* + /** Bring the column of largest norm into the pivot position. */ if (pl <= l && l < pu) { @@ -771,7 +771,7 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], jpvt[l - 1] = jp; } } - /* + /** Compute the Householder transformation for column L. */ qraux[l - 1] = 0.0; @@ -782,7 +782,7 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], nrmxl = nrmxl * r8_sign(a[l - 1 + (l - 1) * lda]); dscal(n - l + 1, 1.0 / nrmxl, a + l - 1 + (l - 1)*lda, 1); a[l - 1 + (l - 1)*lda] = 1.0 + a[l - 1 + (l - 1) * lda]; - /* + /** Apply the transformation to the remaining columns, updating the norms. */ for (j = l + 1; j <= p; j++) { @@ -804,7 +804,7 @@ void dqrdc(double a[], int lda, int n, int p, double qraux[], int jpvt[], } } } - /* + /** Save the transformation. */ qraux[l - 1] = a[l - 1 + (l - 1) * lda]; @@ -819,7 +819,7 @@ int dqrls(double a[], int lda, int m, int n, double tol, int* kr, double b[], double x[], double rsd[], int jpvt[], double qraux[], int itask) /******************************************************************************/ -/* +/** Purpose: DQRLS factors and solves a linear system in the least squares sense. @@ -949,12 +949,12 @@ int dqrls(double a[], int lda, int m, int n, double tol, int* kr, double b[], } ind = 0; - /* + /** Factor the matrix. */ if (itask == 1) dqrank(a, lda, m, n, tol, kr, jpvt, qraux); - /* + /** Solve the least-squares problem. */ dqrlss(a, lda, m, n, *kr, b, x, rsd, jpvt, qraux); @@ -966,7 +966,7 @@ void dqrlss(double a[], int lda, int m, int n, int kr, double b[], double x[], double rsd[], int jpvt[], double qraux[]) /******************************************************************************/ -/* +/** Purpose: DQRLSS solves a linear system in a least squares sense. @@ -1075,7 +1075,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], double qy[], double qty[], double b[], double rsd[], double ab[], int job) /******************************************************************************/ -/* +/** Purpose: DQRSL computes transformations, projections, and least squares solutions. @@ -1222,12 +1222,12 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], int ju; double t; double temp; - /* + /** Set INFO flag. */ info = 0; - /* + /** Determine what is to be computed. */ cqy = ( job / 10000 != 0); @@ -1237,7 +1237,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], cab = ((job % 10) != 0); ju = i4_min(k, n - 1); - /* + /** Special action when N = 1. */ if (ju == 0) { @@ -1257,7 +1257,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], rsd[0] = 0.0; return info; } - /* + /** Set up to compute QY or QTY. */ if (cqy) { @@ -1268,7 +1268,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], for (i = 1; i <= n; i++) qty[i - 1] = y[i - 1]; } - /* + /** Compute QY. */ if (cqy) { @@ -1283,7 +1283,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], } } } - /* + /** Compute Q'*Y. */ if (cqty) { @@ -1297,7 +1297,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], } } } - /* + /** Set up to compute B, RSD, or AB. */ if (cb) { @@ -1320,7 +1320,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], for (i = 1; i <= k; i++) rsd[i - 1] = 0.0; } - /* + /** Compute B. */ if (cb) { @@ -1337,7 +1337,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], } } } - /* + /** Compute RSD or AB as required. */ if (cr || cab) { @@ -1369,7 +1369,7 @@ int dqrsl(double a[], int lda, int n, int k, double qraux[], double y[], void dscal(int n, double sa, double x[], int incx) /******************************************************************************/ -/* +/** Purpose: DSCAL scales a vector by a constant. @@ -1444,7 +1444,7 @@ void dscal(int n, double sa, double x[], int incx) void dswap(int n, double x[], int incx, double y[], int incy) /******************************************************************************/ -/* +/** Purpose: DSWAP interchanges two vectors. @@ -1529,7 +1529,7 @@ void dswap(int n, double x[], int incx, double y[], int incy) void qr_solve(double x[], int m, int n, double a[], double b[]) /******************************************************************************/ -/* +/** Purpose: QR_SOLVE solves a linear system in the least squares sense. diff --git a/Marlin/qr_solve.h b/Marlin/qr_solve.h index 7c6733ebf1..b985d622f2 100644 --- a/Marlin/qr_solve.h +++ b/Marlin/qr_solve.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/servo.cpp b/Marlin/servo.cpp index 961b39a279..1b8442a0de 100644 --- a/Marlin/servo.cpp +++ b/Marlin/servo.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** servo.cpp - Interrupt driven Servo library for Arduino using 16 bit timers- Version 2 Copyright (c) 2009 Michael Margolis. All right reserved. @@ -39,7 +39,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -/* +/** A servo is activated by creating an instance of the Servo class passing the desired pin to the attach() method. The servos are pulsed in the background using the value most recently written using the write() method diff --git a/Marlin/servo.h b/Marlin/servo.h index 410c0719e7..13ce9f1001 100644 --- a/Marlin/servo.h +++ b/Marlin/servo.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** servo.h - Interrupt driven Servo library for Arduino using 16 bit timers- Version 2 Copyright (c) 2009 Michael Margolis. All right reserved. @@ -39,7 +39,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA */ -/* +/** A servo is activated by creating an instance of the Servo class passing the desired pin to the attach() method. The servos are pulsed in the background using the value most recently written using the write() method @@ -71,7 +71,7 @@ #include -/* +/** * Defines for 16 bit timers used with Servo library * * If _useTimerX is defined then TimerX is a 16 bit timer on the current board diff --git a/Marlin/speed_lookuptable.h b/Marlin/speed_lookuptable.h index 1ed4a0b7da..08cc4839a1 100644 --- a/Marlin/speed_lookuptable.h +++ b/Marlin/speed_lookuptable.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/stepper.cpp b/Marlin/stepper.cpp index 9c9c19386c..32ae37eedb 100644 --- a/Marlin/stepper.cpp +++ b/Marlin/stepper.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/stepper.h b/Marlin/stepper.h index f0c3b2d705..aecbf58029 100644 --- a/Marlin/stepper.h +++ b/Marlin/stepper.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** stepper.h - stepper motor driver: executes motion plans of planner.c using the stepper motors Part of Grbl diff --git a/Marlin/stepper_dac.cpp b/Marlin/stepper_dac.cpp index 5830db6e24..2e3248daaa 100644 --- a/Marlin/stepper_dac.cpp +++ b/Marlin/stepper_dac.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** stepper_dac.cpp - To set stepper current via DAC Part of Marlin diff --git a/Marlin/stepper_dac.h b/Marlin/stepper_dac.h index a964704267..d80a846709 100644 --- a/Marlin/stepper_dac.h +++ b/Marlin/stepper_dac.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** stepper_dac.h - To set stepper current via DAC Part of Marlin diff --git a/Marlin/stepper_indirection.cpp b/Marlin/stepper_indirection.cpp index e566cd6190..0ede056143 100644 --- a/Marlin/stepper_indirection.cpp +++ b/Marlin/stepper_indirection.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** stepper_indirection.c - stepper motor driver indirection to allow some stepper functions to be done via SPI/I2c instead of direct pin manipulation Part of Marlin diff --git a/Marlin/stepper_indirection.h b/Marlin/stepper_indirection.h index 264cf7efc8..0a534efdd7 100644 --- a/Marlin/stepper_indirection.h +++ b/Marlin/stepper_indirection.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** stepper_indirection.h - stepper motor driver indirection macros to allow some stepper functions to be done via SPI/I2c instead of direct pin manipulation Part of Marlin diff --git a/Marlin/temperature.cpp b/Marlin/temperature.cpp index ab538e2573..99909204db 100644 --- a/Marlin/temperature.cpp +++ b/Marlin/temperature.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** temperature.cpp - temperature control Part of Marlin @@ -316,7 +316,7 @@ void PID_autotune(float temp, int extruder, int ncycles, bool set_result/*=false SERIAL_PROTOCOLPGM(MSG_KP); SERIAL_PROTOCOLLN(Kp); SERIAL_PROTOCOLPGM(MSG_KI); SERIAL_PROTOCOLLN(Ki); SERIAL_PROTOCOLPGM(MSG_KD); SERIAL_PROTOCOLLN(Kd); - /* + /** Kp = 0.33*Ku; Ki = Kp/Tu; Kd = Kp*Tu/3; @@ -1118,7 +1118,7 @@ void tp_init() { static float tr_target_temperature[EXTRUDERS + 1] = { 0.0 }; - /* + /** SERIAL_ECHO_START; SERIAL_ECHOPGM("Thermal Thermal Runaway Running. Heater ID: "); if (heater_id < 0) SERIAL_ECHOPGM("bed"); else SERIAL_ECHOPGM(heater_id); @@ -1435,7 +1435,7 @@ ISR(TIMER0_COMPB_vect) { #else // SLOW_PWM_HEATERS - /* + /** * SLOW PWM HEATERS * * for heaters drived by relay diff --git a/Marlin/temperature.h b/Marlin/temperature.h index 41a611be16..084b6344db 100644 --- a/Marlin/temperature.h +++ b/Marlin/temperature.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** temperature.h - temperature controller Part of Marlin diff --git a/Marlin/thermistortables.h b/Marlin/thermistortables.h index 6e3f83be93..aeef2c7f76 100644 --- a/Marlin/thermistortables.h +++ b/Marlin/thermistortables.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/ultralcd.cpp b/Marlin/ultralcd.cpp index 96b29e3115..108ce4beaa 100644 --- a/Marlin/ultralcd.cpp +++ b/Marlin/ultralcd.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/ultralcd.h b/Marlin/ultralcd.h index d725ee1858..374310104f 100644 --- a/Marlin/ultralcd.h +++ b/Marlin/ultralcd.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/ultralcd_implementation_hitachi_HD44780.h b/Marlin/ultralcd_implementation_hitachi_HD44780.h index 8613918f9e..c5c8bd04d4 100644 --- a/Marlin/ultralcd_implementation_hitachi_HD44780.h +++ b/Marlin/ultralcd_implementation_hitachi_HD44780.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -533,7 +533,7 @@ unsigned lcd_print(char c) { return charset_mapper(c); } #endif // SHOW_BOOTSCREEN -/* +/** Possible status screens: 16x2 |000/000 B000/000| |0123456789012345| diff --git a/Marlin/ultralcd_st7920_u8glib_rrd.h b/Marlin/ultralcd_st7920_u8glib_rrd.h index 261a5b91a8..9aa53ceaba 100644 --- a/Marlin/ultralcd_st7920_u8glib_rrd.h +++ b/Marlin/ultralcd_st7920_u8glib_rrd.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/utf_mapper.h b/Marlin/utf_mapper.h index 782a36b92c..26e97772bf 100644 --- a/Marlin/utf_mapper.h +++ b/Marlin/utf_mapper.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/vector_3.cpp b/Marlin/vector_3.cpp index 2bc2e90685..1cca0d9d8d 100644 --- a/Marlin/vector_3.cpp +++ b/Marlin/vector_3.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** vector_3.cpp - Vector library for bed leveling Copyright (c) 2012 Lars Brubaker. All right reserved. diff --git a/Marlin/vector_3.h b/Marlin/vector_3.h index 6a40513f89..e76188b04b 100644 --- a/Marlin/vector_3.h +++ b/Marlin/vector_3.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * @@ -20,7 +20,7 @@ * */ -/* +/** vector_3.cpp - Vector library for bed leveling Copyright (c) 2012 Lars Brubaker. All right reserved. diff --git a/Marlin/watchdog.cpp b/Marlin/watchdog.cpp index f8de418073..4397ab603d 100644 --- a/Marlin/watchdog.cpp +++ b/Marlin/watchdog.cpp @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] * diff --git a/Marlin/watchdog.h b/Marlin/watchdog.h index 77e17fa7aa..2c04b58972 100644 --- a/Marlin/watchdog.h +++ b/Marlin/watchdog.h @@ -1,4 +1,4 @@ -/* +/** * Marlin 3D Printer Firmware * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] *