first try to include auto-generated device table in Doxygen

This commit is contained in:
Bjarne von Horn 2023-08-09 20:37:02 +02:00
parent ebfa6ce1c6
commit c332e762c1
5 changed files with 21 additions and 3 deletions

3
.gitignore vendored
View File

@ -43,3 +43,6 @@ script/ethercatctl
script/init.d/ethercat
stamp-h1
tool/ethercat
device_drivers.md
generated_table.md
doxygen-output/

View File

@ -657,7 +657,8 @@ WARN_LOGFILE =
INPUT = @top_srcdir@/master \
@top_srcdir@/include \
@top_srcdir@/devices/ecdev.h
@top_srcdir@/devices/ecdev.h \
@top_builddir@/device_drivers.md
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is

View File

@ -100,10 +100,16 @@ mrproper: clean cleandoc
libtool \
stamp-h1
doc:
generated_table.md: devices/create_driver_table.py
python3 $< --markdown $@ $(abs_srcdir)/devices
device_drivers.md: $(srcdir)/devices/device_drivers_template.md generated_table.md
cat $^ > $@
doc: device_drivers.md
doxygen Doxyfile
cleandoc:
@rm -rf doxygen-output
@rm -rf doxygen-output generated_table.md device_drivers.md
#-----------------------------------------------------------------------------

View File

@ -96,6 +96,7 @@ noinst_HEADERS = \
8139too-5.10-ethercat.c \
8139too-5.10-orig.c \
create_driver_table.py \
device_drivers_template.md \
e100-2.6.20-ethercat.c \
e100-2.6.20-orig.c \
e100-2.6.24-ethercat.c \

View File

@ -0,0 +1,7 @@
Device Drivers
==============
This table contains a list of all available native drivers,
depending on the kernel version.
The `generic` and the `ccat` driver are independent of the kernel version.