Skip to content

Commit 09c3f2d

Browse files
gigapodgigapod
committed
update file headers w/ doxygen comments, modern license declaration
1 parent 7f6dd7a commit 09c3f2d

File tree

13 files changed

+161
-293
lines changed

13 files changed

+161
-293
lines changed

‎src/SparkFun_Toolkit.h‎

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
1-
2-
/*
3-
SparkFun_Toolkit.h
4-
5-
The MIT License (MIT)
6-
7-
Copyright (c) 2023 SparkFun Electronics
8-
9-
Permission is hereby granted, free of charge, to any person obtaining a
10-
copy of this software and associated documentation files (the "Software"),
11-
to deal in the Software without restriction, including without limitation
12-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
13-
and/or sell copies of the Software, and to permit persons to whom the
14-
Software is furnished to do so, subject to the following conditions: The
15-
above copyright notice and this permission notice shall be included in all
16-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
17-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
18-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
19-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23-
24-
*/
1+
/**
2+
* @file SparkFun_Toolkit.h
3+
* @brief Arduino style header file for the SparkFun Toolkit
4+
*
5+
* This file contains the Arduino style header for the SparkFun Toolkit library
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2513

2614
#pragma once
2715

‎src/sfTk/sfTkError.h‎

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
1+
/**
2+
* @file sfTkError.h
3+
* @brief Header file for the SparkFun Toolkit - Base Error Code defines.
4+
*
5+
* This file contains the base error code definitions for the SparkFun Toolkit library.
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
113

2-
// sfeTkError.h
3-
//
4-
// General header file for the SparkFun Toolkit
5-
/*
6-
The MIT License (MIT)
7-
8-
Copyright (c) 2023 SparkFun Electronics
9-
10-
Permission is hereby granted, free of charge, to any person obtaining a
11-
copy of this software and associated documentation files (the "Software"),
12-
to deal in the Software without restriction, including without limitation
13-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
14-
and/or sell copies of the Software, and to permit persons to whom the
15-
Software is furnished to do so, subject to the following conditions: The
16-
above copyright notice and this permission notice shall be included in all
17-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
18-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
19-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
20-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
21-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24-
25-
*/
2614

2715
#pragma once
2816

‎src/sfTk/sfTkIBus.h‎

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,15 @@
1-
2-
// sfTkIBus.h
3-
//
4-
// Defines the communication bus interface for the SparkFun Electronics Toolkit -> sfTk
5-
/*
6-
7-
The MIT License (MIT)
8-
9-
Copyright (c) 2023 SparkFun Electronics
10-
11-
Permission is hereby granted, free of charge, to any person obtaining a
12-
copy of this software and associated documentation files (the "Software"),
13-
to deal in the Software without restriction, including without limitation
14-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
15-
and/or sell copies of the Software, and to permit persons to whom the
16-
Software is furnished to do so, subject to the following conditions: The
17-
above copyright notice and this permission notice shall be included in all
18-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
19-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
20-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
21-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
23-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25-
26-
*/
1+
/**
2+
* @file sfTkIBus.h
3+
* @brief Header file for the SparkFun Toolkit Device Bus Interface Definition.
4+
*
5+
* This file contains the interface declaration for the Communication Bus Interface
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2713

2814
#pragma once
2915

‎src/sfTk/sfTkII2C.h‎

Lines changed: 12 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,15 @@
1-
2-
// sfTkII2C.h
3-
//
4-
// Defines the I2C communication bus interface for the SparkFun Electronics Toolkit
5-
/*
6-
The MIT License (MIT)
7-
8-
Copyright (c) 2023 SparkFun Electronics
9-
10-
Permission is hereby granted, free of charge, to any person obtaining a
11-
copy of this software and associated documentation files (the "Software"),
12-
to deal in the Software without restriction, including without limitation
13-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
14-
and/or sell copies of the Software, and to permit persons to whom the
15-
Software is furnished to do so, subject to the following conditions: The
16-
above copyright notice and this permission notice shall be included in all
17-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
18-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
19-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
20-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
21-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
22-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
23-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24-
25-
*/
1+
/**
2+
* @file sfTkII2C.h
3+
* @brief Header file for the SparkFun Toolkit I2C Interface Definition.
4+
*
5+
* This file contains the interface declaration for the I2C communication bus
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2613

2714
#pragma once
2815

‎src/sfTk/sfTkISPI.h‎

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,15 @@
1-
2-
// sfTkISPI.h
3-
//
4-
// Defines the SPI communication bus interface for the SparkFun Electronics Toolkit
5-
/*
6-
7-
The MIT License (MIT)
8-
9-
Copyright (c) 2023 SparkFun Electronics
10-
11-
Permission is hereby granted, free of charge, to any person obtaining a
12-
copy of this software and associated documentation files (the "Software"),
13-
to deal in the Software without restriction, including without limitation
14-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
15-
and/or sell copies of the Software, and to permit persons to whom the
16-
Software is furnished to do so, subject to the following conditions: The
17-
above copyright notice and this permission notice shall be included in all
18-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
19-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
20-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
21-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
23-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25-
26-
*/
1+
/**
2+
* @file sfTkISPI.h
3+
* @brief Header file for the SparkFun Toolkit SPI Interface Definition.
4+
*
5+
* This file contains the interface declaration for the SPI communication bus
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2713

2814
#pragma once
2915

‎src/sfTk/sfToolkit.cpp‎

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,17 @@
1+
/**
2+
* @file sfToolkit.cpp
3+
* @brief Implementation file for the SparkFun Toolkit.
4+
*
5+
* This file contains the implementation of various utility functions
6+
* for the SparkFun Toolkit library.
7+
*
8+
* @author SparkFun Electronics
9+
* @date 2024-2025
10+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
11+
*
12+
* SPDX-License-Identifier: MIT
13+
*/
14+
115
// File: sfToolkit.cpp
216
//
317
// General impl file for the SparkFun Toolkit

‎src/sfTk/sfToolkit.h‎

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,18 @@
11

2-
// sfToolkit.h
3-
//
4-
// General header file for the SparkFun Toolkit
5-
/*
6-
7-
The MIT License (MIT)
8-
9-
Copyright (c) 2024 SparkFun Electronics
10-
11-
Permission is hereby granted, free of charge, to any person obtaining a
12-
copy of this software and associated documentation files (the "Software"),
13-
to deal in the Software without restriction, including without limitation
14-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
15-
and/or sell copies of the Software, and to permit persons to whom the
16-
Software is furnished to do so, subject to the following conditions: The
17-
above copyright notice and this permission notice shall be included in all
18-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
19-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
20-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
21-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
22-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
23-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
24-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
25-
*/
2+
/**
3+
* @file sfToolkit.h
4+
* @brief Header file for the SparkFun Toolkit.
5+
*
6+
* This file contains the declarations of various utility functions
7+
* and types for the SparkFun Toolkit library.
8+
*
9+
* @author SparkFun Electronics
10+
* @date 2024-2025
11+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
12+
*
13+
* SPDX-License-Identifier: MIT
14+
*/
15+
2616

2717
#pragma once
2818

‎src/sfTkArdI2C.cpp‎

Lines changed: 13 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
1-
/*
2-
sfTkArdI2C.cpp
3-
The MIT License (MIT)
4-
5-
Copyright (c) 2023 SparkFun Electronics
6-
7-
Permission is hereby granted, free of charge, to any person obtaining a
8-
copy of this software and associated documentation files (the "Software"),
9-
to deal in the Software without restriction, including without limitation
10-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
11-
and/or sell copies of the Software, and to permit persons to whom the
12-
Software is furnished to do so, subject to the following conditions: The
13-
above copyright notice and this permission notice shall be included in all
14-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
15-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
16-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
17-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
18-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
19-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
20-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
21-
22-
*/
1+
/**
2+
* @file sfTkArdI2C.h
3+
* @brief Implementation file for the SparkFun Toolkit Arduino I2C driver.
4+
*
5+
* This file contains the Arduino I2C driver for the SparkFun Toolkit library.
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
13+
2314

2415
#include "sfTkArdI2C.h"
2516

‎src/sfTkArdI2C.h‎

Lines changed: 12 additions & 26 deletions
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,15 @@
1-
/*
2-
sfTkArdI2c.h
3-
4-
The MIT License (MIT)
5-
6-
Copyright (c) 2023 SparkFun Electronics
7-
8-
Permission is hereby granted, free of charge, to any person obtaining a
9-
copy of this software and associated documentation files (the "Software"),
10-
to deal in the Software without restriction, including without limitation
11-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
12-
and/or sell copies of the Software, and to permit persons to whom the
13-
Software is furnished to do so, subject to the following conditions: The
14-
above copyright notice and this permission notice shall be included in all
15-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
16-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
17-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
18-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
19-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
20-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
21-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
22-
23-
The following classes specify the behavior for communicating
24-
over Inter-Integrated Circuit (I2C) in Arduino
25-
26-
*/
1+
/**
2+
* @file sfTkArdI2C.cpp
3+
* @brief header file for the SparkFun Toolkit Arduino I2C driver.
4+
*
5+
* This file contains the Arduino I2C header for the SparkFun Toolkit library.
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2713

2814
#pragma once
2915

‎src/sfTkArdSPI.cpp‎

Lines changed: 12 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,15 @@
1-
2-
// sfTkArdSPI.cpp - Arduino SPI implementation for the toolkit
3-
4-
/*
5-
The MIT License (MIT)
6-
7-
Copyright (c) 2023 SparkFun Electronics
8-
9-
Permission is hereby granted, free of charge, to any person obtaining a
10-
copy of this software and associated documentation files (the "Software"),
11-
to deal in the Software without restriction, including without limitation
12-
the rights to use, copy, modify, merge, publish, distribute, sublicense,
13-
and/or sell copies of the Software, and to permit persons to whom the
14-
Software is furnished to do so, subject to the following conditions: The
15-
above copyright notice and this permission notice shall be included in all
16-
copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED
17-
"AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT
18-
NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
19-
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
20-
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
21-
ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
22-
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
23-
24-
*/
1+
/**
2+
* @file sfTkArdSPI.h
3+
* @brief Implementation file for the SparkFun Toolkit Arduino SPI driver.
4+
*
5+
* This file contains the Arduino SPI driver for the SparkFun Toolkit library.
6+
*
7+
* @author SparkFun Electronics
8+
* @date 2024-2025
9+
* @copyright Copyright (c) 2024-2025, SparkFun Electronics Inc. This project is released under the MIT License.
10+
*
11+
* SPDX-License-Identifier: MIT
12+
*/
2513

2614
#include "sfTkArdSPI.h"
2715
#include <Arduino.h>

0 commit comments

Comments
 (0)