From 7cc8b743c2108aee3fa09d9d1dedc7985c225b86 Mon Sep 17 00:00:00 2001 From: Marek Bel Date: Tue, 5 Jun 2018 18:27:36 +0200 Subject: [PATCH] Add .gitignore. Setup doxyfile. Create project documentation main page. Document property of static object constructors on gcc-avr. --- .gitignore | 6 ++++ Firmware/Marlin_main.cpp | 64 +++++++++++++++++++++++++--------------- Firmware/Timer.h | 2 +- Firmware/doxyfile | 6 ++-- 4 files changed, 50 insertions(+), 28 deletions(-) create mode 100644 .gitignore diff --git a/.gitignore b/.gitignore new file mode 100644 index 00000000..8bb12431 --- /dev/null +++ b/.gitignore @@ -0,0 +1,6 @@ +.settings +.project +.cproject +Debug +Firmware/Configuration_prusa.h +Firmware/Doc diff --git a/Firmware/Marlin_main.cpp b/Firmware/Marlin_main.cpp index bed50e8b..202a2722 100644 --- a/Firmware/Marlin_main.cpp +++ b/Firmware/Marlin_main.cpp @@ -1,30 +1,46 @@ /* -*- c++ -*- */ - -/* - Reprap firmware based on Sprinter and grbl. - Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm - - 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 . +/** + * @file */ -/* - This firmware is a mashup between Sprinter and grbl. - (https://github.com/kliment/Sprinter) - (https://github.com/simen/grbl/tree) - - It has preliminary support for Matthew Roberts advance algorithm - http://reprap.org/pipermail/reprap-dev/2011-May/003323.html +/** + * @mainpage Reprap 3D printer firmware based on Sprinter and grbl. + * + * @section intro_sec Introduction + * + * This firmware is a mashup between Sprinter and grbl. + * https://github.com/kliment/Sprinter + * https://github.com/simen/grbl/tree + * + * It has preliminary support for Matthew Roberts advance algorithm + * http://reprap.org/pipermail/reprap-dev/2011-May/003323.html + * + * Prusa Research s.r.o. https://www.prusa3d.cz + * + * @section copyright_sec Copyright + * + * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm + * + * 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 . + * + * @section notes_sec Notes + * + * * Do not create static objects in global functions. + * Otherwise constructor guard against concurrent calls is generated costing + * about 8B RAM and 14B flash. + * + * */ #include "Marlin.h" diff --git a/Firmware/Timer.h b/Firmware/Timer.h index 35173d39..e6f76528 100644 --- a/Firmware/Timer.h +++ b/Firmware/Timer.h @@ -1,4 +1,4 @@ -/* +/** * @file * @author Marek Bel */ diff --git a/Firmware/doxyfile b/Firmware/doxyfile index e56fb18a..6fa1ef4f 100644 --- a/Firmware/doxyfile +++ b/Firmware/doxyfile @@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8 # title of most generated pages and in a few other places. # The default value is: My Project. -PROJECT_NAME = "My Project" +PROJECT_NAME = "Prusa3d Marlin fork" # The PROJECT_NUMBER tag can be used to enter a project or revision number. This # could be handy for archiving the generated documentation or if some version @@ -58,7 +58,7 @@ PROJECT_LOGO = # entered, it will be relative to the location where doxygen was started. If # left blank the current directory will be used. -OUTPUT_DIRECTORY = +OUTPUT_DIRECTORY = Doc # If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub- # directories (in 2 levels) under the output directory of each output format and @@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC = YES # brief descriptions will be completely suppressed. # The default value is: YES. -REPEAT_BRIEF = YES +REPEAT_BRIEF = NO # This tag implements a quasi-intelligent brief description abbreviator that is # used to form the text in various listings. Each string in this list, if found