From 035edd6d7f933dc9357fa26796c26c298e017cf1 Mon Sep 17 00:00:00 2001 From: SMFSW Date: Wed, 12 Jul 2017 22:07:33 +0200 Subject: [PATCH] v0.6: compliance with Arduino v1.5+ IDE specs --- Doxyfile | 25 ++++++++++++++++++++----- Release Notes.txt | 3 +++ library.properties | 6 +++--- ci2c.c => src/ci2c.c | 2 +- ci2c.h => src/ci2c.h | 4 ++-- 5 files changed, 29 insertions(+), 11 deletions(-) rename ci2c.c => src/ci2c.c (99%) rename ci2c.h => src/ci2c.h (99%) diff --git a/Doxyfile b/Doxyfile index af78b41..a041a68 100755 --- a/Doxyfile +++ b/Doxyfile @@ -1,4 +1,4 @@ -# Doxyfile 1.8.11 +# Doxyfile 1.8.13 # This file describes the settings to be used by the documentation system # doxygen (www.doxygen.org) for a project. @@ -38,7 +38,7 @@ PROJECT_NAME = "Arduino Hardware I2C for AVR MCUs (plain c)" # could be handy for archiving the generated documentation or if some version # control system is used. -PROJECT_NUMBER = 0.5 +PROJECT_NUMBER = 0.6 # Using the PROJECT_BRIEF tag one can provide an optional one line description # for a project that appears at the top of each page and should give viewer a @@ -295,6 +295,15 @@ EXTENSION_MAPPING = ino=C++ MARKDOWN_SUPPORT = YES +# When the TOC_INCLUDE_HEADINGS tag is set to a non-zero value, all headings up +# to that level are automatically included in the table of contents, even if +# they do not have an id attribute. +# Note: This feature currently applies only to Markdown headings. +# Minimum value: 0, maximum value: 99, default value: 0. +# This tag requires that the tag MARKDOWN_SUPPORT is set to YES. + +TOC_INCLUDE_HEADINGS = 0 + # When enabled doxygen tries to link words that correspond to documented # classes, or namespaces to their corresponding documentation. Such a link can # be prevented in individual cases by putting a % sign in front of the word or @@ -773,7 +782,8 @@ WARN_LOGFILE = # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING # Note: If this tag is empty the current directory is searched. -INPUT = ./ +INPUT = ./ \ + ./src # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses @@ -795,8 +805,8 @@ INPUT_ENCODING = UTF-8 # If left blank the following patterns are tested:*.c, *.cc, *.cxx, *.cpp, # *.c++, *.java, *.ii, *.ixx, *.ipp, *.i++, *.inl, *.idl, *.ddl, *.odl, *.h, # *.hh, *.hxx, *.hpp, *.h++, *.cs, *.d, *.php, *.php4, *.php5, *.phtml, *.inc, -# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, -# *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. +# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, +# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf. FILE_PATTERNS = *.c \ *.cpp \ @@ -2365,6 +2375,11 @@ DIAFILE_DIRS = PLANTUML_JAR_PATH = +# When using plantuml, the PLANTUML_CFG_FILE tag can be used to specify a +# configuration file for plantuml. + +PLANTUML_CFG_FILE = + # When using plantuml, the specified paths are searched for files specified by # the !include statement in a plantuml block. diff --git a/Release Notes.txt b/Release Notes.txt index c5bf5b7..b0ff117 100755 --- a/Release Notes.txt +++ b/Release Notes.txt @@ -15,6 +15,9 @@ Feel free to share your thoughts @ xgarmanboziax@gmail.com about: ------------ ** Actual: +v0.6 12 Jul 2017: +- compliance with Arduino v1.5+ IDE source located in src subfolder + v0.5 31 Jan 2017: - refactored I2C_SPEED enum names for coherence with I2C specifications - High Speed mode added in I2C_SPEED enum diff --git a/library.properties b/library.properties index d2183fa..46c8d37 100755 --- a/library.properties +++ b/library.properties @@ -1,7 +1,7 @@ name=cI2C -version=0.5 -author=SMFSW -maintainer=SMFSW +version=0.6 +author=SMFSW +maintainer=SMFSW sentence=Arduino Hardware I2C for AVR (in plain c) paragraph=Hardware I2C library for AVR MCUs (lib intended for I2C protocols development in c, for easier ports to other MCUs) category=Communication diff --git a/ci2c.c b/src/ci2c.c similarity index 99% rename from ci2c.c rename to src/ci2c.c index 6d209fb..9be21d8 100755 --- a/ci2c.c +++ b/src/ci2c.c @@ -1,6 +1,6 @@ /*!\file ci2c.c ** \author SMFSW -** \version 0.5 +** \version 0.6 ** \copyright MIT SMFSW (2017) ** \brief arduino master i2c in plain c code **/ diff --git a/ci2c.h b/src/ci2c.h similarity index 99% rename from ci2c.h rename to src/ci2c.h index 6b4cdd4..01dd0db 100755 --- a/ci2c.h +++ b/src/ci2c.h @@ -1,12 +1,12 @@ /*!\file ci2c.h ** \author SMFSW -** \version 0.5 +** \version 0.6 ** \copyright MIT SMFSW (2017) ** \brief arduino i2c in plain c declarations **/ /****************************************************************/ #ifndef __CI2C_H__ - #define __CI2C_H__ "v0.5" + #define __CI2C_H__ /****************************************************************/ #if defined(DOXY)