annotate Documentations/GPL_template.txt @ 238:a9d798e8c11f div-fixes-5

cleanup, bugfix: do not mask I2C_SystemStatus with local variable This commit is partly cleanup, and partly possible bugfix. Masking the global I2C_SystemStatus with a local variable is (very) bad practice, but more importantly, dangerous, as other code uses this I2C_SystemStatus to base decisions on. So, this is definitely non-trivial, as it can possibly change the flow of control. This said, its tested and seems to have no negative effects (but also no positive, as I sort of hoped for), so that is why I mark it cleanup as well. Constructs like this shall be heavily documented in the code, when there is a reason to do things like this. Further, remove a 2nd rather useless construct. There is no reason to & 0x03 the output of I2C_SystemStatus. This is the only location in the entire code base where this is done, so, its not only useless but also inconsistent and confusing the true intentions here. Finally, littered to code with todo's that I will take care of in next commits. Signed-off-by: Jan Mulder <jlmulder@xs4all.nl>
author Jan Mulder <jlmulder@xs4all.nl>
date Mon, 08 Apr 2019 10:16:17 +0200
parents 6237372f76a4
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
1 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
2 /// -*- coding: UTF-8 -*-
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
3 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
4 /// \file $file
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
5 /// \brief $brief
35
6237372f76a4 ... more GPL License and general cleanups
jDG@sauge
parents: 31
diff changeset
6 /// \author Heinrichs Weikamp gmbh
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
7 /// \date $date
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
8 ///
31
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
9 /// \details
da118222e18b [ADD]Discovery/Src licences, plus reindentation
jDG@sauge
parents: 29
diff changeset
10 ///
29
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
11 /// $Id$
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
12 ///////////////////////////////////////////////////////////////////////////////
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
13 /// \par Copyright (c) 2014-2018 Heinrichs Weikamp gmbh
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
14 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
15 /// This program is free software: you can redistribute it and/or modify
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
16 /// it under the terms of the GNU General Public License as published by
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
17 /// the Free Software Foundation, either version 3 of the License, or
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
18 /// (at your option) any later version.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
19 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
20 /// This program is distributed in the hope that it will be useful,
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
21 /// but WITHOUT ANY WARRANTY; without even the implied warranty of
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
22 /// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
23 /// GNU General Public License for more details.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
24 ///
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
25 /// You should have received a copy of the GNU General Public License
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
26 /// along with this program. If not, see <http://www.gnu.org/licenses/>.
3a98f9e7ca58 ADD script to set GPL headers
jDG
parents:
diff changeset
27 //////////////////////////////////////////////////////////////////////////////