mcu
/
libopencm3
mirror of https://github.com/libopencm3/libopencm3.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
2396 Commits
2 Branches
1 Tag
21 MiB
Tree: d88d6fde12
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'd88d6fde12'
${ noResults }
libopencm3/doc/Makefile

56 lines
1.4 KiB
Raw Normal View History

Setup to document entire project using doxygen. New doc directory with config files and generated html, LaTeX/pdf. Makefile provided for autogeneration and explanatory README. The project structure is hostile to doxygen, which can't cope with functions of the same name. Doxygen is run for each family separately, and separately for LaTeX generation. Customized layout files sort of "integrate" HTML, and separate pdfs are generated for each family. Not ideal but seems the best solution until doxygen changes, if at all.
12 years ago
# Makefile to build libopencm3 documentation
# 14 September 2012
# (C) Ken Sarkies <ksarkies@internode.on.net>
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
# setup TARGETS if not set for legacy and ease of debug.
TARGETS ?= stm32/f0 stm32/f1 stm32/f2 stm32/f3 stm32/f4 stm32/f7 \
stm32/l0 stm32/l1 stm32/l4 \
stm32g0: make doc.
6 years ago
stm32/g0 \
doc: hook up gd32f1x0 documentation Super easy now thanks to the earlier changes.
6 years ago
gd32/f1x0 \
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
efm32/g efm32/gg efm32/hg efm32/lg efm32/tg \
lm3s lm4f \
msp432/e4 \
lpc13xx lpc17xx lpc43xx \
sam/3a sam/3n sam/3s sam/3u sam/3x \
swm050: add back into doc generation? Not sure where this went. I was building docs for it to make the doxygen work, but then, it&#39;s not here?! Anyway, here now :)
5 years ago
vf6xx \
swm050
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
TARGETS_DIRS = $(subst /,,$(TARGETS))
[Doxygen] Strip out architectures from Makefile dependencies This commit shrinks the Makefile of the doxygen and makes easy error-prone addition of the new supported platforms. The user should modify only one line at start of file to add new supported family to the build process. The calling format is preserved and is compatible with old version of the makefile.
10 years ago
doc: drop latex support HTML output is good enough for anyone, and is less maintennance.
7 years ago
doc: html
Setup to document entire project using doxygen. New doc directory with config files and generated html, LaTeX/pdf. Makefile provided for autogeneration and explanatory README. The project structure is hostile to doxygen, which can&#39;t cope with functions of the same name. Doxygen is run for each family separately, and separately for LaTeX generation. Customized layout files sort of &#34;integrate&#34; HTML, and separate pdfs are generated for each family. Not ideal but seems the best solution until doxygen changes, if at all.
12 years ago
[Doxygen] Strip out architectures from Makefile dependencies This commit shrinks the Makefile of the doxygen and makes easy error-prone addition of the new supported platforms. The user should modify only one line at start of file to add new supported family to the build process. The calling format is preserved and is compatible with old version of the makefile.
10 years ago
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
DoxygenLayout.xml: templates/DoxygenLayout_Root.xml
../scripts/gendoxylayout.py --template $< --out $@ $(TARGETS_DIRS)
define gen_DOC_TARGET
DOC_TARGETS += doc_$(1)
$(1)/:
@mkdir -p $$@
$(1)/doxy.sourcelist: $(1)/
@../scripts/gendoxylist ../lib/$(TARGET_SRC_DIR) $(1)
$(1)/Doxyfile: templates/Doxyfile_Device | $(1)/
doc: oops, no need to call sed -s, unbreak make doc on os x Not sure how/why i pushed thqt, absolutely no need to call sed with -s parameter. Fix build on os x / systems running non gnu sed.
6 years ago
@cat $$< | sed s/#device#/$(1)/g > $$@
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
$(1)/DoxygenLayout_$(1).xml: templates/DoxygenLayout_Device.xml | $(1)/
@../scripts/gendoxylayout.py --template $$< --out $$@ --target $(1) $$(TARGETS_DIRS)
doc_$(1): $(1)/doxy.sourcelist $(1)/Doxyfile $(1)/DoxygenLayout_$(1).xml
@(cd $(1); doxygen)
endef
$(foreach TARGET_SRC_DIR, $(TARGETS), $(eval $(call gen_DOC_TARGET,$(subst /,,$(TARGET_SRC_DIR)))))
html: $(DOC_TARGETS) DoxygenLayout.xml
doxygen
[sam3] show the sam3 subfamilies in the doxygen-generated documentation
11 years ago
Setup to document entire project using doxygen. New doc directory with config files and generated html, LaTeX/pdf. Makefile provided for autogeneration and explanatory README. The project structure is hostile to doxygen, which can&#39;t cope with functions of the same name. Doxygen is run for each family separately, and separately for LaTeX generation. Customized layout files sort of &#34;integrate&#34; HTML, and separate pdfs are generated for each family. Not ideal but seems the best solution until doxygen changes, if at all.
12 years ago
clean:
doc: attempt to get rid of doxygenlayouts and doxyfiles. Generate doc root doxygenlayout file, as well as devices stuff, based on main Makefile $(TARGETS) and template files. Avoids painfull sync/merge of 20 files+ when adding a new device. bonus : allow to build only one device doc easily (make TARGETS=stm32f0 doc) regression: we currently loose device &#34;fancy&#34; naming as device name is guessed (toUpper()..) from folder name.
6 years ago
@rm -rf html/ $(TARGETS_DIRS) DoxygenLayout.xml doxygen.log
.PHONY: doc html $(DOC_TARGETS)
Setup to document entire project using doxygen. New doc directory with config files and generated html, LaTeX/pdf. Makefile provided for autogeneration and explanatory README. The project structure is hostile to doxygen, which can&#39;t cope with functions of the same name. Doxygen is run for each family separately, and separately for LaTeX generation. Customized layout files sort of &#34;integrate&#34; HTML, and separate pdfs are generated for each family. Not ideal but seems the best solution until doxygen changes, if at all.
12 years ago