Skip to content

Commit df3c5ae

Browse files
author
Tobias Libera
committed
Added comment heads
1 parent af12c2c commit df3c5ae

File tree

4 files changed

+91
-3
lines changed

4 files changed

+91
-3
lines changed

GRBL_HBridge/Config.h

+26-3
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
/*
2+
Config.h - Arduino header file
3+
Part of GRBL_HBridge
4+
https://github.com/TobiasLibera/GRBL_HBridge
5+
6+
Copyright (c) 2024 Tobias Libera
7+
8+
GRBL_HBridge is free software: you can redistribute it and/or modify
9+
it under the terms of the GNU General Public License as published by
10+
the Free Software Foundation, either version 3 of the License, or
11+
(at your option) any later version.
12+
13+
GRBL_HBridge is distributed in the hope that it will be useful,
14+
but WITHOUT ANY WARRANTY; without even the implied warranty of
15+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16+
GNU General Public License for more details.
17+
18+
You should have received a copy of the GNU General Public License
19+
along with Grbl. If not, see <http://www.gnu.org/licenses/>.
20+
*/
121

222
#ifndef GRBL_HBRIDGE_CONFIG_H
323
#define GRBL_HBRIDGE_CONFIG_H
@@ -93,9 +113,12 @@
93113
/*
94114
ATTENTION:
95115
I recommend to only edit the following values
96-
if you studied the code and you know, what
97-
your changes afflect.
116+
if you studied the code and you are aware of
117+
what your modifications afflect.
118+
*/
98119

120+
121+
/*
99122
PWM_DETERMINE_FREQ [Hz]
100123
This value controls how often per second a new
101124
PWM input value is given to the PWM output handler.
@@ -142,7 +165,7 @@
142165

143166

144167
/*
145-
modify_pwm_output()
168+
modify_pwm_output() [void Function(void)]
146169
You can use this function to modify the PWM Output Pin.
147170
For example for manipulation of Port Registers to
148171
adjust the PWM signal.

GRBL_HBridge/GRBL_HBridge.h

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
/*
2+
GRBL_HBridge.h - Arduino header file
3+
Part of GRBL_HBridge
4+
https://github.com/TobiasLibera/GRBL_HBridge
5+
6+
Copyright (c) 2024 Tobias Libera
7+
8+
GRBL_HBridge is free software: you can redistribute it and/or modify
9+
it under the terms of the GNU General Public License as published by
10+
the Free Software Foundation, either version 3 of the License, or
11+
(at your option) any later version.
12+
13+
GRBL_HBridge is distributed in the hope that it will be useful,
14+
but WITHOUT ANY WARRANTY; without even the implied warranty of
15+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16+
GNU General Public License for more details.
17+
18+
You should have received a copy of the GNU General Public License
19+
along with Grbl. If not, see <http://www.gnu.org/licenses/>.
20+
*/
121

222
#ifndef GRBL_HBRIDGE_H
323
#define GRBL_HBRIDGE_H

GRBL_HBridge/GRBL_HBridge.ino

+20
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,23 @@
1+
/*
2+
GRBL_HBridge.ino - Arduino sketch file
3+
Part of GRBL_HBridge
4+
https://github.com/TobiasLibera/GRBL_HBridge
5+
6+
Copyright (c) 2024 Tobias Libera
7+
8+
GRBL_HBridge is free software: you can redistribute it and/or modify
9+
it under the terms of the GNU General Public License as published by
10+
the Free Software Foundation, either version 3 of the License, or
11+
(at your option) any later version.
12+
13+
GRBL_HBridge is distributed in the hope that it will be useful,
14+
but WITHOUT ANY WARRANTY; without even the implied warranty of
15+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16+
GNU General Public License for more details.
17+
18+
You should have received a copy of the GNU General Public License
19+
along with Grbl. If not, see <http://www.gnu.org/licenses/>.
20+
*/
121

222
#include "GRBL_HBridge.h"
323

LICENSE

+25
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,28 @@
1+
------------------------------------------------------------------------------
2+
COPYRIGHT NOTICE FOR GRBL_HBRIDGE:
3+
------------------------------------------------------------------------------
4+
5+
GRBL_HBridge - HBridge adaption for GRBL CNC controller
6+
7+
Copyright (c) 2024 Tobias Libera
8+
9+
GRBL_HBridge is free software: you can redistribute it and/or modify
10+
it under the terms of the GNU General Public License as published by
11+
the Free Software Foundation, either version 3 of the License, or
12+
(at your option) any later version.
13+
14+
GRBL_HBridge is distributed in the hope that it will be useful,
15+
but WITHOUT ANY WARRANTY; without even the implied warranty of
16+
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17+
GNU General Public License for more details.
18+
19+
You should have received a copy of the GNU General Public License
20+
along with Grbl. If not, see <http://www.gnu.org/licenses/>.
21+
22+
------------------------------------------------------------------------------
23+
GNU GPLv3 TERMS AND CONDITIONS REPRODUCED HERE FOR CLARITY:
24+
------------------------------------------------------------------------------
25+
126
GNU GENERAL PUBLIC LICENSE
227
Version 3, 29 June 2007
328

0 commit comments

Comments
 (0)