Skip to content

Commit 3aa399b

Browse files
committed
minor: Cleanup docs
1 parent 171eab4 commit 3aa399b

5 files changed

Lines changed: 17 additions & 9 deletions

File tree

docs/BUILDING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,9 @@ Depending on your system, you may need to install the following libraries.
3838

3939
Debian:
4040

41-
````
41+
```
4242
sudo apt-get install libtool libusb-1.0-0-dev librtlsdr-dev rtl-sdr build-essential cmake pkg-config
43-
````
43+
```
4444

4545
* If you require TLS connections, also install `libssl-dev` (`sudo apt-get install libssl-dev`).
4646

@@ -49,17 +49,17 @@ Centos/Fedora/RHEL with EPEL repo using cmake:
4949
* If `dnf` doesn't exist, use `yum`.
5050
* If you require TLS connections, install `openssl-devel`.
5151

52-
````
52+
```
5353
sudo dnf install libtool libusb1-devel rtl-sdr-devel rtl-sdr cmake
54-
````
54+
```
5555

5656
Mac OS X with MacPorts:
5757

5858
* If you require TLS connections, install `openssl` from either MacPorts or Homebrew.
5959

60-
````
60+
```
6161
sudo port install rtl-sdr cmake
62-
````
62+
```
6363

6464
Mac OS X with Homebrew:
6565

docs/INTEGRATION.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ There is also a newer plugin using MQTT: [enesbcs/pyrtl433](https://github.com/e
107107
Testing and example needed
108108
:::
109109

110-
# NodeRED
110+
## NodeRED
111111

112112
[NodeRED](https://nodered.org/) - Flow-based programming for the Internet of Things
113113

docs/LINKS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
- [Spectrogram](http://triq.org/pdv) to visualize sample files
1313
- [BitBench](http://triq.org/bitbench) to analyze data formats
1414

15-
# Related projects
15+
## Related projects
1616

1717
- [ShinySDR](https://shinysdr.switchb.org/)
1818
Web remote-controllable SDR receiver application supporting multiple simultaneous hardware devices and demodulators, including rtl_433 and other decoding tools.

src/devices/schraeder.c

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,7 @@ TPMS Model: Schrader Electronics EG53MA4.
8484
Contributed by: Leonardo Hamada (hkazu).
8585
8686
Also Schrader Opel OEM No. 13348393 TPMS Sensor (might be found in Saab, Opel, Vauxhall, Chevrolet).
87+
GM (Chevrolet) OEM No. 13540600 for 2006-2025 GM.
8788
8889
Probable packet payload:
8990

tests/symbolizer.py

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,6 +85,7 @@ def process_source(path, name):
8585
fileDoc = False
8686
dLine = None
8787
dSee = None
88+
dSee2 = None
8889
doc = None
8990
for i, line in enumerate(f):
9091
# look for documentation comments:
@@ -109,9 +110,12 @@ def process_source(path, name):
109110
continue
110111
if captureDoc:
111112
doc += line
112-
m = re.match(r'\s*\@sa\s+(.*?)\(\)\s*', line)
113+
# TODO: we should use a list
114+
m = re.match(r'\s*\@sa\s+(.*?)\(\)\s*(?:(.*?)\(\))?', line)
113115
if m:
114116
dSee = m.group(1)
117+
if m.group(2):
118+
dSee2 = m.group(2)
115119
continue
116120
# inline link /** @sa func() */
117121
m = re.match(r'\s*/\*\*\s*\@sa\s+(.*?)\(\)\s*\*/', line)
@@ -236,6 +240,9 @@ def process_source(path, name):
236240
if dSee:
237241
links[fName].update({"doc_line": dLine, "doc_see": dSee})
238242
dSee = None
243+
if dSee2:
244+
links[fName].update({"doc_line": dLine, "doc_see2": dSee2})
245+
dSee2 = None
239246
if doc:
240247
links[fName].update({"doc_line": dLine, "doc": doc})
241248
doc = None

0 commit comments

Comments
 (0)