Add doxygen support for the tools in clang-tools-extra

Patch by Ariel Bernal.


git-svn-id: https://llvm.org/svn/llvm-project/clang-tools-extra/trunk@176267 91177308-0d34-0410-b5e6-96231b3b80d8
This commit is contained in:
Dmitri Gribenko 2013-02-28 16:46:40 +00:00
Родитель 290465d625
Коммит 7cb63b8dcc
4 изменённых файлов: 1849 добавлений и 1 удалений

1808
docs/Doxyfile Normal file

Разница между файлами не показана из-за своего большого размера Загрузить разницу

Просмотреть файл

@ -16,6 +16,8 @@ I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext .PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
all: doxygen html
help: help:
@echo "Please use \`make <target>' where <target> is one of" @echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files" @echo " html to make standalone HTML files"
@ -151,3 +153,8 @@ doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \ @echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt." "results in $(BUILDDIR)/doctest/output.txt."
doxygen:
mkdir -p $(BUILDDIR)/html/doxygen
doxygen

11
docs/README.txt Normal file
Просмотреть файл

@ -0,0 +1,11 @@
------------------------------------------------------------
Documetation for the tools of clang-tools-extra repo project
------------------------------------------------------------
Sphinx and doxygen documentation is generated by executing make.
Sphinx html files can be generated separately using make html.
Doxygen html files can also be generated using make doxygen.
The generated documentation will be placed in _build/html.

Просмотреть файл

@ -5,14 +5,36 @@
.. title:: Welcome to Extra Clang Tools's documentation! .. title:: Welcome to Extra Clang Tools's documentation!
Contents: Introduction
============
Welcome to clang-tools-exta project which contains extra tools built using Clang's tooling API's
Contents
========
.. toctree:: .. toctree::
:maxdepth: 1 :maxdepth: 1
cpp11-migrate cpp11-migrate
Doxygen Documentation
=====================
This documentation describes the **internal** software that makes up the
tools of clang-tools-extra, not the **external** use of these tools. There
are no instructions here on how to use the tools, only the APIs that make
up the software. For usage instructions, please see the user's guide or
reference manual for each tool.
* `Doxygen documentation`_
.. _`Doxygen documentation`: doxygen/index.html
.. note::
This documentation is generated directly from the source code with doxygen.
Since the tools of clang-tools-extra are constantly under active development,
what you're about to read is out of date!
Indices and tables Indices and tables
================== ==================