From 7a04eb3a8b80e2c67eb7c35e83be84d761aa3d1a Mon Sep 17 00:00:00 2001 From: Scott Lahteine Date: Tue, 23 Oct 2018 22:35:09 -0500 Subject: [PATCH] Fix some comment formatting --- .../src/HAL/HAL_DUE/MarlinSerialUSB_Due.cpp | 4 +- Marlin/src/HAL/HAL_STM32/spi_pins.h | 35 +++++++------ Marlin/src/HAL/HAL_STM32F4/spi_pins.h | 50 ++++++++----------- Marlin/src/HAL/HAL_STM32F7/spi_pins.h | 41 +++++++-------- Marlin/src/lcd/lcdprint_hd44780.cpp | 20 ++++---- 5 files changed, 69 insertions(+), 81 deletions(-) diff --git a/Marlin/src/HAL/HAL_DUE/MarlinSerialUSB_Due.cpp b/Marlin/src/HAL/HAL_DUE/MarlinSerialUSB_Due.cpp index b0a00840ad..b176f9d0d9 100644 --- a/Marlin/src/HAL/HAL_DUE/MarlinSerialUSB_Due.cpp +++ b/Marlin/src/HAL/HAL_DUE/MarlinSerialUSB_Due.cpp @@ -143,8 +143,8 @@ void MarlinSerialUSB::write(const uint8_t c) { } /** -* Imports from print.h -*/ + * Imports from print.h + */ void MarlinSerialUSB::print(char c, int base) { print((long)c, base); diff --git a/Marlin/src/HAL/HAL_STM32/spi_pins.h b/Marlin/src/HAL/HAL_STM32/spi_pins.h index 2a97ee9c6f..df1dd5483d 100644 --- a/Marlin/src/HAL/HAL_STM32/spi_pins.h +++ b/Marlin/src/HAL/HAL_STM32/spi_pins.h @@ -1,26 +1,25 @@ /** -* Marlin 3D Printer Firmware -* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation, either version 3 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program. If not, see . -* -*/ + * Marlin 3D Printer Firmware + * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ #pragma once /** * Define SPI Pins: SCK, MISO, MOSI, SS - * */ #ifndef SCK_PIN #define SCK_PIN 13 diff --git a/Marlin/src/HAL/HAL_STM32F4/spi_pins.h b/Marlin/src/HAL/HAL_STM32F4/spi_pins.h index f178ac8107..577b36aeb8 100644 --- a/Marlin/src/HAL/HAL_STM32F4/spi_pins.h +++ b/Marlin/src/HAL/HAL_STM32F4/spi_pins.h @@ -1,41 +1,35 @@ /** -* Marlin 3D Printer Firmware -* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation, either version 3 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program. If not, see . -* -*/ - -#ifndef SPI_PINS_H_ -#define SPI_PINS_H_ - + * Marlin 3D Printer Firmware + * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ +#pragma once /** * Define SPI Pins: SCK, MISO, MOSI, SS - * */ #ifndef SCK_PIN - #define SCK_PIN PA5 + #define SCK_PIN PA5 #endif #ifndef MISO_PIN - #define MISO_PIN PA6 + #define MISO_PIN PA6 #endif #ifndef MOSI_PIN - #define MOSI_PIN PA7 + #define MOSI_PIN PA7 #endif #ifndef SS_PIN - #define SS_PIN PA8 + #define SS_PIN PA8 #endif - -#endif // SPI_PINS_H_ diff --git a/Marlin/src/HAL/HAL_STM32F7/spi_pins.h b/Marlin/src/HAL/HAL_STM32F7/spi_pins.h index 2d1e96ec59..9301f4dd8c 100644 --- a/Marlin/src/HAL/HAL_STM32F7/spi_pins.h +++ b/Marlin/src/HAL/HAL_STM32F7/spi_pins.h @@ -1,32 +1,27 @@ /** -* Marlin 3D Printer Firmware -* Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] -* -* This program is free software: you can redistribute it and/or modify -* it under the terms of the GNU General Public License as published by -* the Free Software Foundation, either version 3 of the License, or -* (at your option) any later version. -* -* This program is distributed in the hope that it will be useful, -* but WITHOUT ANY WARRANTY; without even the implied warranty of -* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the -* GNU General Public License for more details. -* -* You should have received a copy of the GNU General Public License -* along with this program. If not, see . -* -*/ - -#ifndef SPI_PINS_H_ -#define SPI_PINS_H_ + * Marlin 3D Printer Firmware + * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin] + * + * This program is free software: you can redistribute it and/or modify + * it under the terms of the GNU General Public License as published by + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + * + */ +#pragma once /** * Define SPI Pins: SCK, MISO, MOSI, SS - * */ #define SCK_PIN PA5 #define MISO_PIN PA6 #define MOSI_PIN PA7 #define SS_PIN PA8 - -#endif // SPI_PINS_H_ diff --git a/Marlin/src/lcd/lcdprint_hd44780.cpp b/Marlin/src/lcd/lcdprint_hd44780.cpp index fbbb748b3d..85c23b2d8c 100644 --- a/Marlin/src/lcd/lcdprint_hd44780.cpp +++ b/Marlin/src/lcd/lcdprint_hd44780.cpp @@ -1010,16 +1010,16 @@ int lcd_put_wchar_max(wchar_t c, pixel_len_t max_length) { } /** -* @brief Draw a UTF-8 string -* -* @param utf8_str : the UTF-8 string -* @param cb_read_byte : the callback function to read one byte from the utf8_str (from RAM or ROM) -* @param max_length : the pixel length of the string allowed (or number of slots in HD44780) -* -* @return the number of pixels advanced -* -* Draw a UTF-8 string -*/ + * @brief Draw a UTF-8 string + * + * @param utf8_str : the UTF-8 string + * @param cb_read_byte : the callback function to read one byte from the utf8_str (from RAM or ROM) + * @param max_length : the pixel length of the string allowed (or number of slots in HD44780) + * + * @return the number of pixels advanced + * + * Draw a UTF-8 string + */ static int lcd_put_u8str_max_cb(const char * utf8_str, uint8_t (*cb_read_byte)(uint8_t * str), pixel_len_t max_length) { pixel_len_t ret = 0; uint8_t *p = (uint8_t *)utf8_str;