Commit Graph

7 Commits

Author SHA1 Message Date
Karl Palsson 81d1b2cfb6 gendoxylist: make it not "crash" if you try interactively at least 2020-11-28 22:13:25 +00:00
Karl Palsson 8d80db0319 gendoxylist: sort headers
This makes the doxygen lists much more rationally ordered.
2019-06-25 21:15:19 +00:00
Karl Palsson a21aeab3b1 doc: make sure include/cm3 is pulled in properly.
Much as we had to pull in the individual target's include files
manually, because they're useful without necessarily having .c files
using them, the cortex core headers also need to be included.  This also
pulls in the doc-cm3.h file that setup nice groupings.
2018-09-09 15:27:41 +00:00
Karl Palsson d68604dedd doc: gendoxylist: fix syntax error for first file
Was hidden earlier by missing new line.
2018-02-13 23:05:21 +00:00
Karl Palsson efa49e6431 doc: gendoxylist: fix missing first file
Missing a \n in the descriptive print.
2018-02-13 23:05:21 +00:00
Karl Palsson 313d82ba02 doxygen: include all target headers
Even if they haven't been referenced from a .c file.  Some peripherals
start their life as register definitions only, and they should still
have the documentation generated.

There _will_ be overlap in the generated lists, but doxygen doesn't seem
to mind this.
2017-10-23 21:05:54 +00:00
Karl Palsson d002d9552f doc: dynamically generate correct file lists
Instead of the fragile and error prone attempts to specifically
include/exclude files from doxygen by name and pattern, simply use the
already generated .d files to provide accurate and up to date lists of
all source files used.

Pros:
* Nothing left to worry about
* Much more encouraging to actually _work_ on the documentation now that
you can be sure the right docs will be generated instead of a confusing
mix.

Downsides/Upsides:
* Automatically includes all CM3/USB in each device's page _as well_ now

Downsides:
* lpc43xx still manually listed.  However, completely contained in it's
own dir, so no problems
* No attempt to carry this in latex.  easy, but more tempted to drop
latex support outright. (I don't think the generation there has even
worked for a while now)
* Due to the mismatch between lib directories and document roots, the
sourcelist can't be magically created per directory.  There has to be
some sort of mapping between the two, so as this is doc generation only,
a static list seems sane for maintennance.  (Especially compared to the
old method)
* Source list generation probably doesn't work on windows.
2017-10-18 20:05:14 +00:00