aboutsummaryrefslogtreecommitdiff
path: root/Doxyfile.in
AgeCommit message (Collapse)AuthorFilesLines
2021-01-13Doxyfile.in: exclude libjaylink from doxygenAntonio Borneo1-1/+1
When build using libjaylink as git submodule, doxygen includes the libjaylink files and complains for multiple 'mainpage' comment block, one in OpenOCD and the other in libjaylink: src/jtag/drivers/libjaylink/libjaylink/core.c:37: warning: found more than one \mainpage comment block! (first occurrence: doc/manual/main.txt, line 1), Skipping current block! Exclude libjaylink submodule from doxygen. Change-Id: I5e856817344c9f21f8c26f077a23c00b83cfbcb5 Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/6000 Tested-by: jenkins
2021-01-13Doxyfile.in: fix build out-of-treeAntonio Borneo1-1/+1
When doxygen is built out-of-tree, it fails to find the generated file startup_tcl.inc: src/openocd.c:59: warning: include file startup_tcl.inc not found, perhaps you forgot to add its directory to INCLUDE_PATH? Add '@builddir@/src' to INCLUDE_PATH. Change-Id: I51f2f6fe7224bba0f8b3db7219f9831de4e67139 Signed-off-by: Antonio Borneo <borneo.antonio@gmail.com> Reviewed-on: http://openocd.zylin.com/5998 Tested-by: jenkins
2018-01-30doxygen: fix issues with recent Doxygen versionsPaul Fertser1-1/+1
This fixes parsing of several documentation files which do not have dot in the filename. style.txt change fixes doxygen warnings and ensures proper display of comment begin/end instructions in HTML. Tested with Doxygen 1.8.13. Change-Id: I9fd9ac3b51b47076b8fdbd3e93b90c3eba9b9631 Signed-off-by: Paul Fertser <fercerpav@gmail.com> Reviewed-on: http://openocd.zylin.com/4342 Tested-by: jenkins
2013-07-01doxygen: use inline jtag state maching imageSpencer Oliver1-1/+1
The currently used image is 404 so use an inline image instead. Change-Id: I56a0d187fd06dc2c5c370e6532d89815ccec63d6 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/1451 Tested-by: jenkins
2012-10-02docs: enable local structs in doxygen outputSpencer Oliver1-1/+1
Change-Id: I9c811d49690524f1ce5372326de67ec4ac7b09f4 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/858 Tested-by: jenkins Reviewed-by: Freddie Chopin <freddie.chopin@gmail.com>
2012-05-28docs: include static members in doxygen outputSpencer Oliver1-1/+1
Change-Id: I1867e8d7a3bed1a399c0790f63fee68fb6b299c4 Signed-off-by: Spencer Oliver <spen@spen-soft.co.uk> Reviewed-on: http://openocd.zylin.com/672 Tested-by: jenkins Reviewed-by: Xiaofan <xiaofanc@gmail.com>
2012-01-18doc: Update patch procedureTimo Ketola1-1/+1
Change-Id: I3e50357b4ddaf483712bbac68b6427b31529f666 Signed-off-by: Timo Ketola <timo@exertus.fi> Reviewed-on: http://openocd.zylin.com/387 Tested-by: jenkins Reviewed-by: Øyvind Harboe <oyvindharboe@gmail.com> Reviewed-by: Spencer Oliver <spen@spen-soft.co.uk>
2010-01-21Various doc/comment updatesDavid Brownell1-4/+4
Doxygen: don't be needlessly verbose; alphabetically sort members TODO: add random bits; clarify which manuals are referenced ARM disassembler: mention a few opcodes that still aren't handled Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2010-01-10build: doxygen buildSpencer Oliver1-1/+1
- Fix for building doxygen out of tree Signed-off-by: Spencer Oliver <ntfreak@users.sourceforge.net>
2010-01-08Coexist with quilt: rename PATCHES --> PATCHES.txtDavid Brownell1-1/+1
The issues is on Win32, which ignores case in filesystem and thus doesn't tolerate the quilt "patches" directory. Rename, and add "patches" to .gitignore so that developers can choose to use quilt for local patch management. Signed-off-by: David Brownell <dbrownell@users.sourceforge.net>
2009-11-17allow documentation to be configuredZachary T Welch1-2/+2
Add --disable-doxygen-html and --enable-doxygen-pdf options to the configure script, allowing user to change the defaults. These update the proess of munging the Doxygen configuration file to use the settings thusly provided. Add options in README.
2009-11-17update doxygen configuration to produce a PDFZachary T Welch1-8/+8
A single PDF file for the developer manual allows accessing a single index, browsing, and searching. It takes significantly more time to build this way, but this patch allows others to look at the results. Migration Tip: If you have previously built the HTML Doxygen documentatation, rename your 'doxygen' directory to 'doxygen/html' to prevent needlessly rebuilding those files.
2009-11-01doxygen: avoid most internalsDavid Brownell1-2/+2
For some reason, all the interals are documented by default. This is wrong for two basic reasons:  - We need to focus on public interfaces, since those are the architectural interfaces and relationships.  - Since virtually nothing has doxygen support yet, this    maximizes the noise, and minimizes the usefulness of doxygen output. So don't expose so much by default.
2009-05-24Properly fix doxygen out-of-tree build process:zwelch1-0/+1517
- move Doxyfile to Doxyfile.in: type 'make Doxyfile' to recreate it - create Doxyfile from Doxyfile.in with make rule: - use sed substitution of $(srcdir) to location directories - delete all doxygen created files with 'make distclean' - include all required files (including logger.pl) in distribution git-svn-id: svn://svn.berlios.de/openocd/trunk@1901 b42882b7-edfa-0310-969c-e2dbd0fdcd60
generated by cgit v1.1 at 2024-11-07 00:23:43 +0000