Skip to content

Commit 32a8c7f

Browse files
dlechdlech
committed
autogenerated docs for kernel 3.16.1-8-ev3dev
1 parent 4d7b0a1 commit 32a8c7f

69 files changed

Lines changed: 290 additions & 1 deletion

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎_data/ports.json‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,8 @@
2222
"name": "ht-nxt-smux-port",
2323
"num_modes": 2,
2424
"prefix": "mux",
25+
"source_file": "drivers/lego/sensors/ht_nxt_smux.c",
26+
"source_line": 38,
2527
"url_name": "ht-nxt-smux-port"
2628
},
2729
{
@@ -81,6 +83,8 @@
8183
"name": "legoev3-input-port",
8284
"num_modes": 8,
8385
"prefix": "in",
86+
"source_file": "drivers/lego/ev3/legoev3_ports_in.c",
87+
"source_line": 289,
8488
"url_name": "legoev3-input-port"
8589
},
8690
{
@@ -127,6 +131,8 @@
127131
"name": "legoev3-output-port",
128132
"num_modes": 5,
129133
"prefix": "out",
134+
"source_file": "drivers/lego/ev3/legoev3_ports_out.c",
135+
"source_line": 138,
130136
"url_name": "legoev3-output-port"
131137
},
132138
{
@@ -152,6 +158,8 @@
152158
"name": "ms-ev3-smux-port",
153159
"num_modes": 2,
154160
"prefix": "mux",
161+
"source_file": "drivers/lego/sensors/ms_ev3_smux.c",
162+
"source_line": 40,
155163
"url_name": "ms-ev3-smux-port"
156164
},
157165
{
@@ -168,6 +176,8 @@
168176
"name": "wedo-port",
169177
"num_modes": 1,
170178
"prefix": "wedo",
179+
"source_file": "drivers/lego/wedo/wedo_port.c",
180+
"source_line": 331,
171181
"url_name": "wedo-port"
172182
}
173183
]

‎_data/sensors.json‎

Lines changed: 84 additions & 0 deletions
Large diffs are not rendered by default.

‎_layouts/docs.html‎

Lines changed: 13 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,23 @@
22
layout: page
33
---
44

5+
{% if page.source_file %}
6+
{% assign edit_path = page.source_file | replace: 'drivers/lego', 'https://github.com/ev3dev/lego-linux-drivers/edit/master' %}
7+
{% if page.source_line > 0 %}
8+
{% assign source_line = page.source_line | plus: 0 %}
9+
{% assign edit_path = edit_path | append: '#L' | append: source_line %}
10+
{% endif %}
11+
{% else %}
12+
{% assign edit_path = site.github.repository_url | append: '/edit/master/' | append: page.path %}
13+
{% endif %}
514
<div class="edit-on-github">
6-
<a href="{{ site.github.repository_url }}/edit/master/{{ page.path }}">Edit on Github</a>
15+
<a href="{{ edit_path }}">Edit on Github</a>
716
</div>
817
<div class="breadcrumbs">
918
{% include breadcrumbs.html %}
19+
{% if page.kernel_version %}
20+
(kernel: {{ page.kernel_version }})
21+
{% endif %}
1022
</div>
1123
<hr />
1224

‎docs/drivers/dc-motor-class.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/motors/dc_motor_class.c
35
title: DC Motor Class
46
---
57

@@ -51,3 +53,4 @@ with -ENOSYS.
5153
100%. Valid values are 0 to 10000 (10 seconds). Default is 0. If the
5254
controller does not support ramping, then reading and writing will fail
5355
with -ENOSYS.
56+

‎docs/drivers/ev3-analog-sensor.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/sensors/ev3_analog_sensor_core.c
35
title: EV3 Analog Sensor Driver
46
---
57

@@ -15,3 +17,4 @@ are.
1517

1618
[lego-sensor class]: ../lego-sensor-class
1719
[supported sensors]: ../#supported-sensors
20+

‎docs/drivers/ev3-tacho-motor.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/motors/ev3_tacho_motor.c
35
title: EV3/NXT Tacho Motor Driver
46
---
57

@@ -13,3 +15,4 @@ there though - all of the useful stuff is in the [tacho-motor] class.
1315

1416
[tacho-motor]: ../taco-motor-class
1517
[incremental rotary encoder]: https://en.wikipedia.org/wiki/Rotary_encoder#Incremental_rotary_encoder
18+

‎docs/drivers/ev3-uart-sensor-ld.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/sensors/ev3_uart_sensor_ld.c
35
title: EV3 UART Sensor Line Discipline
46
---
57

@@ -24,3 +26,4 @@ class] `device_name` attribute is not a real driver name. Instead it returns
2426
[line discipline]: https://en.wikipedia.org/wiki/Line_discipline
2527
[lego-sensor class]: ../lego-sensor-class
2628
[works with any tty]: http://lechnology.com/2014/09/using-uart-sensors-on-any-linux/
29+

‎docs/drivers/ht-nxt-smux-i2c-sensor.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/sensors/ht_nxt_smux_i2c_sensor.c
35
title: HiTechnic NXT Sensor Multiplexer I2C sensor driver
46
---
57

@@ -25,3 +27,4 @@ for more information.
2527
[ht-nxt-smux-port]: /docs/ports/ht-nxt-smux-port
2628
[list of supported sensors]: /docs/sensors#supported-sensors
2729
[lego-sensor class]: ../lego-sensor-class
30+

‎docs/drivers/ht-nxt-smux.markdown‎

Whitespace-only changes.

‎docs/drivers/lego-port-class.markdown‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
---
22
autogen: This file was automatically generated by kernel-doc-text-to-markdown.py
3+
kernel_version: 3.16.1-8-ev3dev
4+
source_file: drivers/lego/core/lego_port_class.c
35
title: LEGO Port Class Driver
46
---
57

@@ -50,3 +52,4 @@ device to be registered for that driver and attached to this port. For
5052
example, since Analog/NXT sensors cannot be auto-detected, you must use
5153
this attribute to load the correct driver. Returns -ENOSYS if setting a
5254
device is not supported.
55+

0 commit comments

Comments
 (0)