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.
1505 Commits
2 Branches
1 Tag
21 MiB
Tree: 641fbffe9a
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '641fbffe9a'
${ noResults }
libopencm3/doc/Makefile

116 lines
2.6 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: html latex
[DOXYGEN] Correct generating docs for STM32F0 and STM32F3
11 years ago
html: cm3 usb stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg lm3s lm4f lpc13 lpc17 lpc43 top
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
cm3:
cd cm3/; doxygen
Documentation structures added to place the non-STM32 families into the documentation tree. Actual documentation has not been added. Volunteers?
12 years ago
usb:
cd usb/; doxygen
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
lm3s:
cd lm3s/; doxygen
doc: Include LM4F files when creating documentation There was no reference to LM4F in in the doc/ subdirectory. Add the needed infrastructure to generate focumentation for LM4F. Signed-off-by: Alexandru Gagniuc &lt;mr.nuke.me@gmail.com&gt;
12 years ago
lm4f:
cd lm4f/; doxygen
Documentation updates
12 years ago
efm32g:
cd efm32g/; doxygen
efm32gg:
cd efm32gg/; doxygen
efm32lg:
cd efm32lg/; doxygen
efm32tg:
cd efm32tg/; doxygen
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
lpc13:
cd lpc13xx/; doxygen
lpc17:
cd lpc17xx/; doxygen
lpc43:
cd lpc43xx/; doxygen
[Doxygen] Add complete documentation page to STM32F0
11 years ago
stm32f0:
cd stm32f0/; doxygen
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
stm32f1:
cd stm32f1/; doxygen
stm32f2:
cd stm32f2/; doxygen
[DOXYGEN] Correct generating docs for STM32F0 and STM32F3
11 years ago
stm32f3:
cd stm32f3/; doxygen
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
stm32f4:
cd stm32f4/; doxygen
Documentation updates
12 years ago
stm32l1:
cd stm32l1/; doxygen
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
top:
doxygen
[DOXYGEN] Correct generating docs for STM32F0 and STM32F3
11 years ago
latex: stm32l1.pdf stm32f0.pdf stm32f1.pdf stm32f2.pdf stm32f3.pdf stm32f4.pdf lm3s.pdf lm4f.pdf lpc13.pdf lpc17.pdf lpc43.pdf efm32g.pdf efm32gg.pdf efm32lg.pdf efm32tg.pdf
Documentation updates
12 years ago
stm32l1.pdf:
cd stm32l1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32l1.pdf
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] Add complete documentation page to STM32F0
11 years ago
stm32f0.pdf:
cd stm32f0/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f0.pdf
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
stm32f1.pdf:
cd stm32f1/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f1.pdf
stm32f2.pdf:
cd stm32f2/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f2.pdf
[DOXYGEN] Correct generating docs for STM32F0 and STM32F3
11 years ago
stm32f3.pdf:
cd stm32f3/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f3.pdf
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
stm32f4.pdf:
cd stm32f4/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../stm32f4.pdf
lm3s.pdf:
cd lm3s/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lm3s.pdf
doc: Include LM4F files when creating documentation There was no reference to LM4F in in the doc/ subdirectory. Add the needed infrastructure to generate focumentation for LM4F. Signed-off-by: Alexandru Gagniuc &lt;mr.nuke.me@gmail.com&gt;
12 years ago
lm4f.pdf:
cd lm4f/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lm4f.pdf
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
lpc13.pdf:
cd lpc13xx/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lpc13.pdf
lpc17.pdf:
cd lpc17xx/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lpc17.pdf
lpc43.pdf:
cd lpc43xx/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../lpc43.pdf
Documentation updates
12 years ago
efm32g.pdf:
cd efm32g/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32g.pdf
efm32gg.pdf:
cd efm32gg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32gg.pdf
efm32lg.pdf:
cd efm32lg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32lg.pdf
efm32tg.pdf:
cd efm32tg/; doxygen Doxyfile_latex; cd latex/; $(MAKE); cp refman.pdf ../../efm32tg.pdf
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:
@rm -rf html/ */html/ */latex/ *.pdf */*.tag
[DOXYGEN] Correct generating docs for STM32F0 and STM32F3
11 years ago
.PHONY: doc html cm3 usb lm3s lm4f lpc13 lpc17 lpc43 stm32l1 stm32f0 stm32f1 stm32f2 stm32f3 stm32f4 efm32g efm32gg efm32lg efm32tg top latex
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