Commit Graph

29 Commits

Author SHA1 Message Date
Matthias Braun
5f364c15da Doxygen: Use mathjax to create formulas.
The main motivation is to not require a latex installation when building
the documentation. I would also expect a better image quality and the
ability to copy&paste from formulas with a javascript based solution for
displaying the math.

Differential Revision: http://reviews.llvm.org/D14960

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@254048 91177308-0d34-0410-b5e6-96231b3b80d8
2015-11-25 00:50:47 +00:00
Hans Wennborg
8d5e5d4170 Doxygen: add build option to use svg instead of png files for graphs
Differential Revision: http://reviews.llvm.org/D11994

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@245256 91177308-0d34-0410-b5e6-96231b3b80d8
2015-08-17 23:24:17 +00:00
Matthias Braun
1cf942cb4f Doxygen: Enable autobrief feature and update coding standards.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@237417 91177308-0d34-0410-b5e6-96231b3b80d8
2015-05-15 03:34:01 +00:00
Logan Chien
f7a833adfd [docs] Update the doxygen configuration file.
Update the doxygen configuration file and Makefile build rules
to provide better output (simply use the default stylesheet and template
from the Doxygen distribution.)

This CL has upgrade doxygen.cfg.in to Doxygen 1.8.6.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@232064 91177308-0d34-0410-b5e6-96231b3b80d8
2015-03-12 17:26:27 +00:00
Michael Gottesman
fac2487347 [docs] Teach CMake docs build how to generate Qt Creator help/documentation files.
Patch by Konrad Kleine.

Differential Revision: http://llvm-reviews.chandlerc.com/D2967

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@203272 91177308-0d34-0410-b5e6-96231b3b80d8
2014-03-07 19:19:28 +00:00
Alp Toker
baf8c08693 Fix documentation typos
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@197757 91177308-0d34-0410-b5e6-96231b3b80d8
2013-12-20 00:33:39 +00:00
Michael Gottesman
4cff093bd6 [doxygen] Use correct variable names for external variable configuration and make EXTRA_SEARCH_MAPPINGS a "dumb" variable.
I do not think the massaging that I was doing for EXTRA_SEARCH_MAPPINGS was
truly necessary.

git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189522 91177308-0d34-0410-b5e6-96231b3b80d8
2013-08-28 21:55:26 +00:00
Michael Gottesman
1800b662a0 [doxygen] Added support for doxygen external search.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@189507 91177308-0d34-0410-b5e6-96231b3b80d8
2013-08-28 20:28:35 +00:00
Tanya Lattner
0f24175120 Reapply r141657.
Also revert the change to CREATE_SUBDIRS as this is what caused the CSS to break on the website and generate the much longer URLs.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@143401 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-31 23:46:50 +00:00
Tanya Lattner
7102b703bf Revert r141657 for now. This has broken css and changed links on llvm.org. I'd like to understand exactly why the links have changed and if a newer doxygen is required. This may be reapplied once we upgrade on llvm.org and it is fully tested.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@142686 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-21 20:51:54 +00:00
Bill Wendling
28588e12ad Enable CREATE_SUBDIRS for a performance win, because there are a lot of files being generated.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@142112 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-16 06:43:10 +00:00
Bill Wendling
eb13b61d3d Update to a newer doxygen version. PR8214. Patch by Jeremy Huddleston.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@141657 91177308-0d34-0410-b5e6-96231b3b80d8
2011-10-11 07:25:38 +00:00
mike-m
e2c3a49c80 Revert r103213. It broke several sections of live website.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103219 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-07 00:28:04 +00:00
mike-m
68cb31901c Overhauled llvm/clang docs builds. Closes PR6613.
NOTE: 2nd part changeset for cfe trunk to follow.

*** PRE-PATCH ISSUES ADDRESSED

- clang api docs fail build from objdir
- clang/llvm api docs collide in install PREFIX/
- clang/llvm main docs collide in install
- clang/llvm main docs have full of hard coded destination
  assumptions and make use of absolute root in static html files;
  namely CommandGuide tools hard codes a website destination
  for cross references and some html cross references assume
  website root paths

*** IMPROVEMENTS

- bumped Doxygen from 1.4.x -> 1.6.3
- splits llvm/clang docs into 'main' and 'api' (doxygen) build trees
- provide consistent, reliable doc builds for both main+api docs
- support buid vs. install vs. website intentions
- support objdir builds
- document targets with 'make help'
- correct clean and uninstall operations
- use recursive dir delete only where absolutely necessary
- added call function fn.RMRF which safeguards against botched 'rm -rf';
  if any target (or any variable is evaluated) which attempts
  to remove any dirs which match a hard-coded 'safelist', a verbose
  error will be printed and make will error-stop.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@103213 91177308-0d34-0410-b5e6-96231b3b80d8
2010-05-06 23:45:43 +00:00
Cristian Cadar
fb57f1c8ec Test commit.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@72092 91177308-0d34-0410-b5e6-96231b3b80d8
2009-05-19 01:56:08 +00:00
Tanya Lattner
6a0fd93547 Upgrade doxygen.
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@56308 91177308-0d34-0410-b5e6-96231b3b80d8
2008-09-18 16:32:28 +00:00
Reid Spencer
0713ca4255 Comment out configuration tags not supported by doxygen 1.3.9
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@40853 91177308-0d34-0410-b5e6-96231b3b80d8
2007-08-05 19:51:03 +00:00
Reid Spencer
80626a7f6f Upgrade in preparation for doxygen 1.4.4. The config file format changed,
there are new/different css styles to support, and the footer was woefully
out of date.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@28308 91177308-0d34-0410-b5e6-96231b3b80d8
2006-05-15 21:36:13 +00:00
Reid Spencer
50ffe0c7d1 * Truncate a long line.
* By default, doxygen output formatted for printing on letter size paper
  not A4.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@22034 91177308-0d34-0410-b5e6-96231b3b80d8
2005-05-14 20:06:31 +00:00
Reid Spencer
22e4cdedb6 For PR393:
This file was originally doxygen.cfg, but it needs to be configured to get
the right srcdir/objdir paths for things. This is needed because building
the doxygen will now be part of the install and dist-check targets.


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@18315 91177308-0d34-0410-b5e6-96231b3b80d8
2004-11-29 03:33:22 +00:00
Reid Spencer
06a3db0b0f Reduce the number of columns in the alpha index to 4 so that it fits
on a 1280x1024 screen!


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@14158 91177308-0d34-0410-b5e6-96231b3b80d8
2004-06-12 14:46:02 +00:00
Misha Brukman
f804e2c587 Removed obsolete doxygen options (they were blank anyway).
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@12965 91177308-0d34-0410-b5e6-96231b3b80d8
2004-04-15 15:33:49 +00:00
Chris Lattner
b0fa659981 Add a bunch of fine tunings that Reid contributed. Thanks Reid!
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@10666 91177308-0d34-0410-b5e6-96231b3b80d8
2003-12-31 06:47:28 +00:00
Misha Brukman
8ba67902ca * Align comments into 80 columns
* Stop using full pathnames (we don't know where the source could be)
* Use only relative distance to the source, so a user can download the code and
  generate their own copy of the doxygen documentation easily
* Since `docs' has moved one level up, all relative path names lost a `..'


git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@9213 91177308-0d34-0410-b5e6-96231b3b80d8
2003-10-17 23:00:03 +00:00
Chris Lattner
695766dd08 Don't hardcode path to dot in the doxygen config file. Let doxygen search the PATH
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3949 91177308-0d34-0410-b5e6-96231b3b80d8
2002-09-26 16:45:59 +00:00
Chris Lattner
1d3d7114ff Fix config file due to directories changing
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3667 91177308-0d34-0410-b5e6-96231b3b80d8
2002-09-10 22:39:04 +00:00
Chris Lattner
846f5351e9 Make doxygen not exclude doxygenized comments from the source code listings
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3479 91177308-0d34-0410-b5e6-96231b3b80d8
2002-08-22 22:44:22 +00:00
Chris Lattner
47fe337172 Don't doxygenize the boost libraries
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@3079 91177308-0d34-0410-b5e6-96231b3b80d8
2002-07-25 15:05:28 +00:00
Chris Lattner
3785a662c2 Checkin support for building doxygen stuff
git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@1586 91177308-0d34-0410-b5e6-96231b3b80d8
2002-01-26 21:16:41 +00:00