Undocumented entities

[dkfellows]

There remain quite a few things in the tools that are not documented even after #116. There's also a lot of warnings about return type of member not being documented, but that's a Doxygen bug (with the handling of static void functions) and can mostly be ignored as it will go away once we manage to switch builds to use the next version of Doxygen (which missed the Ubuntu 2020 LTS release by a few weeks); I've excluded them from the list below (check the Travis build logs for the full list).

$ make doxygen
doxygen
/home/travis/build/SpiNNakerManchester/spinnaker_tools/include/sark.h:69: warning: Member DRIFT_INT_MASK (macro definition) of file sark.h is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/include/sark.h:70: warning: Member DRIFT_FRAC_MASK (macro definition) of file sark.h is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/include/sark.h:71: warning: Member DRIFT_ONE (macro definition) of file sark.h is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/include/sark.h:72: warning: Member TIME_BETWEEN_SYNC_US (macro definition) of file sark.h is not documented.
[...]
/home/travis/build/SpiNNakerManchester/spinnaker_tools/spin1_api/spin1_isr.c:31: warning: Member user_pending (variable) of file spin1_isr.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/spin1_api/spin1_isr.c:32: warning: Member user_arg0 (variable) of file spin1_isr.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/spin1_api/spin1_isr.c:33: warning: Member user_arg1 (variable) of file spin1_isr.c is not documented.
(cd bmp; exec doxygen)
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_can.c:88: warning: Compound rx_desc is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp.h:764: warning: Member bmp_power_status_commands (enumeration) of file bmp.h is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp.h:792: warning: Member up_time (variable) of file bmp.h is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_net.c:53: warning: explicit link request to 'sdp_msg_t' could not be resolved
[...]
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_clock.c:35: warning: Member XTAL_CLK (macro definition) of file bmp_clock.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_clock.c:54: warning: Member bmp_clock_0_select (enumeration) of file bmp_clock.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_clock.c:71: warning: Member bmp_clock_1_select (enumeration) of file bmp_clock.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_clock.c:87: warning: Member bmp_clock_power_control (enumeration) of file bmp_clock.c is not documented.
[...]
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:454: warning: Member ADC_PDN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:114: warning: Member P3_EN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:115: warning: Member P3_INIT (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:122: warning: Member P4_EN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:123: warning: Member P4_INIT (macro definition) of file bmp_hw.c is not documented.
[...]
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:51: warning: Member P0_EN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:53: warning: Member P0_INIT (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:42: warning: Member gpio_bits_port_0 (enumeration) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:74: warning: Member P1_EN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:77: warning: Member P1_INIT (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:60: warning: Member gpio_bits_port_1 (enumeration) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:102: warning: Member XINIT_B (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:104: warning: Member P2_EN (macro definition) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:84: warning: Member gpio_bits_port_2 (enumeration) of file bmp_hw.c is not documented.
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:42: warning: parameters of member gpio_bits_port_0 are not (all) documented
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:60: warning: parameters of member gpio_bits_port_1 are not (all) documented
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_hw.c:84: warning: parameters of member gpio_bits_port_2 are not (all) documented
[...]
/home/travis/build/SpiNNakerManchester/spinnaker_tools/bmp/bmp_net.c:53: warning: explicit link request to 'sdp_msg_t' could not be resolved
[...]