Merge pull request #15 from SV-Zanshin/Development_v1.0.5

Development v1.0.5

.clang-format

@@ -0,0 +1,156 @@
+################################################################################
+## Google formatting file. Auto-generated from "LLVM" Style and then modified ##
+##                                                                            ##
+## Date       Developer  Description                                          ##
+## ========== ========== =====================================================##
+## 2020-07-05 SV-Zanshin Removed unknown options                              ##
+## 2020-06-28 SV-Zanshin Changed indentation                                  ##
+##                                                                            ##
+################################################################################
+---
+Language: Cpp
+AccessModifierOffset: -1
+AlignAfterOpenBracket: Align
+##AlignConsecutiveMacros: true
+AlignConsecutiveAssignments: true
+AlignConsecutiveDeclarations: true
+AlignEscapedNewlines: Left
+AlignOperands:   true
+AlignTrailingComments: true
+AllowAllParametersOfDeclarationOnNextLine: true
+AllowShortBlocksOnASingleLine: false
+AllowShortCaseLabelsOnASingleLine: false
+AllowShortFunctionsOnASingleLine: All
+#AllowShortLambdasOnASingleLine: All
+AllowShortIfStatementsOnASingleLine: true
+AllowShortLoopsOnASingleLine: true
+AlwaysBreakAfterDefinitionReturnType: None
+AlwaysBreakAfterReturnType: None
+AlwaysBreakBeforeMultilineStrings: true
+AlwaysBreakTemplateDeclarations: Yes
+BinPackArguments: true
+BinPackParameters: true
+BraceWrapping:
+  AfterClass:      false
+  AfterControlStatement: false
+  AfterEnum:       false
+  AfterFunction:   false
+  AfterNamespace:  false
+  AfterObjCDeclaration: false
+  AfterStruct:     false
+  AfterUnion:      false
+  AfterExternBlock: false
+  BeforeCatch:     false
+  BeforeElse:      false
+  IndentBraces:    false
+  SplitEmptyFunction: true
+  SplitEmptyRecord: true
+  SplitEmptyNamespace: true
+BreakBeforeBinaryOperators: None
+BreakBeforeBraces: Attach
+BreakBeforeInheritanceComma: false
+BreakInheritanceList: BeforeColon
+BreakBeforeTernaryOperators: true
+BreakConstructorInitializersBeforeComma: false
+BreakConstructorInitializers: BeforeColon
+BreakAfterJavaFieldAnnotations: false
+BreakStringLiterals: true
+ColumnLimit:     100
+CommentPragmas:  '^ IWYU pragma:'
+CompactNamespaces: false
+ConstructorInitializerAllOnOneLineOrOnePerLine: true
+ConstructorInitializerIndentWidth: 4
+ContinuationIndentWidth: 4
+Cpp11BracedListStyle: true
+DerivePointerAlignment: true
+DisableFormat:   false
+ExperimentalAutoDetectBinPacking: false
+FixNamespaceComments: true
+ForEachMacros:
+  - foreach
+  - Q_FOREACH
+  - BOOST_FOREACH
+IncludeBlocks:   Regroup
+IncludeCategories:
+  - Regex:           '^<ext/.*\.h>'
+    Priority:        2
+  - Regex:           '^<.*\.h>'
+    Priority:        1
+  - Regex:           '^<.*'
+    Priority:        2
+  - Regex:           '.*'
+    Priority:        3
+IncludeIsMainRegex: '([-_](test|unittest))?$'
+IndentCaseLabels: true
+IndentPPDirectives: None
+IndentWidth:     2
+IndentWrappedFunctionNames: false
+JavaScriptQuotes: Leave
+JavaScriptWrapImports: true
+KeepEmptyLinesAtTheStartOfBlocks: false
+MacroBlockBegin: ''
+MacroBlockEnd:   ''
+MaxEmptyLinesToKeep: 1
+NamespaceIndentation: None
+ObjCBinPackProtocolList: Never
+ObjCBlockIndentWidth: 2
+ObjCSpaceAfterProperty: false
+ObjCSpaceBeforeProtocolList: true
+PenaltyBreakAssignment: 2
+PenaltyBreakBeforeFirstCallParameter: 1
+PenaltyBreakComment: 300
+PenaltyBreakFirstLessLess: 120
+PenaltyBreakString: 1000
+PenaltyBreakTemplateDeclaration: 10
+PenaltyExcessCharacter: 1000000
+PenaltyReturnTypeOnItsOwnLine: 200
+PointerAlignment: Left
+RawStringFormats:
+  - Language:        Cpp
+    Delimiters:
+      - cc
+      - CC
+      - cpp
+      - Cpp
+      - CPP
+      - 'c++'
+      - 'C++'
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+  - Language:        TextProto
+    Delimiters:
+      - pb
+      - PB
+      - proto
+      - PROTO
+    EnclosingFunctions:
+      - EqualsProto
+      - EquivToProto
+      - PARSE_PARTIAL_TEXT_PROTO
+      - PARSE_TEST_PROTO
+      - PARSE_TEXT_PROTO
+      - ParseTextOrDie
+      - ParseTextProtoOrDie
+    CanonicalDelimiter: ''
+    BasedOnStyle:    google
+ReflowComments:  true
+SortIncludes:    true
+SortUsingDeclarations: true
+SpaceAfterCStyleCast: false
+SpaceAfterTemplateKeyword: true
+SpaceBeforeAssignmentOperators: true
+SpaceBeforeCpp11BracedList: false
+SpaceBeforeCtorInitializerColon: true
+SpaceBeforeInheritanceColon: true
+SpaceBeforeParens: ControlStatements
+SpaceBeforeRangeBasedForLoopColon: true
+SpaceInEmptyParentheses: false
+SpacesBeforeTrailingComments: 2
+SpacesInAngles:  false
+SpacesInContainerLiterals: true
+SpacesInCStyleCastParentheses: false
+SpacesInParentheses: false
+SpacesInSquareBrackets: false
+TabWidth:        8
+UseTab:          Never
+...

.github/CODE_OF_CONDUCT.md

@@ -75,4 +75,4 @@ available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.ht
 For answers to common questions about this code of conduct, see
 https://www.contributor-covenant.org/faq
 
-![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
+[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)

.github/CONTRIBUTING.md

@@ -10,9 +10,11 @@ Push to your fork and submit a gitHub pull request.
 
 At this point the ball is no longer in your court but on our side. There will be a response within a couple of days, at most. 
 
-Some things that will increase the spped at which a pull request is completed:
+Some things that will increase the speed at which a pull request is completed:
 
 * Write tests.
-* Follow the existing coding style (comments are done with [doxygen](http://www.doxygen.nl/).
-* Write as much information as a beginner would need to understand the problem and solution.
+* Follow the existing coding style, using [Google Style Guide](https://google.github.io/styleguide/cppguide.html)
+* Follow the existing program documentation style using [doxygen](http://www.doxygen.nl/)
+* Write as much information as a beginner would need to understand the problem and solution
 
+[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,22 +1,31 @@
+---
+name: Bug report
+about: Submit a bug report
+title: {Add Short one-line Bug title}
+labels: bug
+assignees: SV-Zanshin
+
+---
+
 ## Expected Behavior
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+_Detail what the expected program behavior should be, or what is expected to happen._
 
 ## Actual Behavior
 
-Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
+_Detail what actually happens._
 
 ## Steps to Reproduce the Problem
 
+_Explain what needs to be done in order to reproduce the problem._
   1.
-  1.
-  1.
+  2.
+  3.
 
 ## Specifications
 
-  - Version:
+  - Library Version:
+  - IDE Version:
   - Platform:
   - Subsystem:
-
-
-![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
+  - _any other details needed to reproduce the problem_

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,22 +1,20 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
-labels: ''
-assignees: ''
+title: {add one-line description of the feature request}
+labels: enhancement
+assignees: SV-Zanshin
 
 ---
 
-**Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+**Describe what the feature request is and if it solves an issue or adds functionality**
+_A clear and concise description of what the problem is which would be solved by the feature request. Example "It would be helpful to add a function newFunc() to solve the problem of [...]"_
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+_A clear and concise description of what you want to have changed or added._
 
 **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+_A clear and concise description of any alternative solutions or features you've considered._
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
-
-![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
+_Add any other context or screenshots about the feature request here._

.github/ISSUE_TEMPLATE/implementation-question.md

@@ -0,0 +1,10 @@
+---
+name: Implementation Question
+about: Ask a question about the library implementation
+title: {One-Line descriptive question title}
+labels: question
+assignees: SV-Zanshin
+
+---
+
+_Ask your question or post your comment here, adding any information, examples, links, etc. that someone would reasonably be expected to have in order to give a response._

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,14 +1,14 @@
 # Description
-Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies 
-then these should be listed here.
+_Please include a text summary of the change and which issue(s) is/are fixed or addressed. Should the change have any dependencies 
+then these should be listed here._
 
 Fixes # (issue)
-In order to make tracking easier and to properly document the process,
-pull requests should always refer to an active issue in the list - be it a bug fix or an enhancement or some other type of issue.
+_In order to make tracking easier and to properly document the process,
+pull requests should always refer to an active issue in the list - be it a bug fix or an enhancement or some other type of issue._
 
 ## Type of change
 
-Please delete options that are not relevant.
+_Please delete options that are not relevant._
 
 - [ ] Bug fix (non-breaking change which fixes an issue)
 - [ ] New feature (non-breaking change which adds functionality)
@@ -17,26 +17,30 @@ Please delete options that are not relevant.
 
 # How Has This Been Tested?
 
-Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration
+_Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration_
 
 - [ ] Test A
 - [ ] Test B
 
 **Test Configuration**:
 * Arduino version:
 * Arduino Hardware:
-* SDK: (Arduino IDE, Atmel Studio, etc.)
+* SDK: (Arduino IDE, Atmel Studio, Visual Studio, Visual Micro, etc.)
+* Development sytem: (Windows, Web, Linux, etc.)
 
 # Checklist:
 
 - [ ] The changes made link back to an existing issue number
 - [ ] I have performed a self-review of my own code
 - [ ] My code follows the style guidelines of this project
 - [ ] I have commented my code, particularly in hard-to-understand areas
+- [ ] The code adheres to the [Google Style Guide](https://google.github.io/styleguide/cppguide.html)
+- [ ] The code follows the existing program documentation style using [doxygen](http://www.doxygen.nl/)
 - [ ] I have made corresponding changes to the documentation / Wiki Page(s)
 - [ ] My changes generate no new warnings
+- [ ] The automated TRAVIS-CI run has a status of "passed"
 - [ ] I have checked potential areas where regression errors could occur and have found no issues
 - [ ] I have added tests that prove my fix is effective or that my feature works
 - [ ] New and existing unit tests pass locally with my changes
 
-![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
+[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)

.github/README.md

@@ -10,4 +10,4 @@ The DS3231M is available as a SO8 or SO16 package and runs on both 3V and 5V sys
 ## Description
 A detailed description of the library along with further details are available at the GitHub [DS3231M Wiki](https://github.com/SV-Zanshin/DS3231M/wiki). This includes wiring information and sample sketches that illustrate the library and it's functionality.
 
-![Zanshin Logo](https://www.sv-zanshin.com/r/images/site/gif/zanshinkanjitiny.gif) <img src="https://www.sv-zanshin.com/r/images/site/gif/zanshintext.gif" width="75"/>
+[![Zanshin Logo](https://zanduino.github.io/Images/zanshinkanjitiny.gif) <img src="https://zanduino.github.io/Images/zanshintext.gif" width="75"/>](https://www.sv-zanshin.com)

.travis.yml

@@ -3,11 +3,12 @@
 ##                                                                                                  ##
 ## Date       Developer           Comments                                                          ##
 ## ========== =================== ================================================================= ##
-## 2020-05-11 Arnd@SV-Zanshin     Removed uneeded install libraries                                 ##
-## 2019-02-02 Arnd@SV-Zanshin     Uncommented doxygen callorrected PRETTYNAME                       ##
-## 2019-01-27 Arnd@SV-Zanshin     Corrected PRETTYNAME                                              ##
-## 2019-01-20 Arnd@SV-Zanshin     Linked to Adafruit script rather than manually defining all tests ##
-## 2019-01-19 Arnd@SV-Zanshin     Initial coding                                                    ##
+## 2020-09-28 SV-Zanshin          Issue #14, added clang-format checking                            ##
+## 2020-05-11 SV-Zanshin          Removed uneeded install libraries                                 ##
+## 2019-02-02 SV-Zanshin          Uncommented doxygen callorrected PRETTYNAME                       ##
+## 2019-01-27 SV-Zanshin          Corrected PRETTYNAME                                              ##
+## 2019-01-20 SV-Zanshin          Linked to Adafruit script rather than manually defining all tests ##
+## 2019-01-19 SV-Zanshin          Initial coding                                                    ##
 ##                                                                                                  ##
 ######################################################################################################
 language: c
@@ -21,13 +22,24 @@ branches:
 git:
   depth: false
   quiet: true
+  addons:
+  apt:
+    sources:
+      - llvm-toolchain-trusty-5.0
+      - key_url: 'http://apt.llvm.org/llvm-snapshot.gpg.key'
+    packages:
+      - python3-pip
+      - python3-wheel
+      - clang-format-5.0
+
 env:
   global:
     - PRETTYNAME="SV-Zanshin Maxim Integrated DS3231M I2C Thermometer Arduino Library"
     - DOXYFILE: $TRAVIS_BUILD_DIR/Doxyfile
 
 before_install:
   - source <(curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/install.sh)
+  - curl -SLs https://raw.githubusercontent.com/adafruit/travis-ci-arduino/master/run-clang-format.py > run-clang-format.py
 
 install:
 

Doxyfile

@@ -3,12 +3,13 @@
 ##                                                                                                  ##
 ## Date       Developer           Comments                                                          ##
 ## ========== =================== ================================================================= ##
+## 2020-06-04 Arnd@SV-Zanshin     Updated version to v1.0.5                                         ##
 ## 2020-05-11 Arnd@SV-Zanshin     Removed all comments in order to compact this file                ##
 ##                                                                                                  ##
 ######################################################################################################
 DOXYFILE_ENCODING      = UTF-8
 PROJECT_NAME           = DS3231M
-PROJECT_NUMBER         = "Version 1.0.3"
+PROJECT_NUMBER         = "Version 1.0.5"
 PROJECT_BRIEF          = "Arduino Library for DS3231M Real-Time clock"
 PROJECT_LOGO           =
 OUTPUT_DIRECTORY       =
@@ -283,4 +284,4 @@ MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = NO
 DOT_MULTI_TARGETS      = NO
 GENERATE_LEGEND        = YES
-DOT_CLEANUP            = YES
+DOT_CLEANUP            = YES