[llvm] r262786 - [docs] Updated docs to work with Doxygen 1.8.11

Alexander Kornienko via llvm-commits llvm-commits at lists.llvm.org
Sat Mar 5 19:50:09 PST 2016


Author: alexfh
Date: Sat Mar  5 21:50:08 2016
New Revision: 262786

URL: http://llvm.org/viewvc/llvm-project?rev=262786&view=rev
Log:
[docs] Updated docs to work with Doxygen 1.8.11

Added:
    llvm/trunk/docs/doxygen-mainpage.dox
      - copied, changed from r262784, llvm/trunk/docs/doxygen.intro
Removed:
    llvm/trunk/docs/doxygen.intro
Modified:
    llvm/trunk/docs/doxygen.cfg.in

Copied: llvm/trunk/docs/doxygen-mainpage.dox (from r262784, llvm/trunk/docs/doxygen.intro)
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/doxygen-mainpage.dox?p2=llvm/trunk/docs/doxygen-mainpage.dox&p1=llvm/trunk/docs/doxygen.intro&r1=262784&r2=262786&rev=262786&view=diff
==============================================================================
--- llvm/trunk/docs/doxygen.intro (original)
+++ llvm/trunk/docs/doxygen-mainpage.dox Sat Mar  5 21:50:08 2016
@@ -1,18 +1,18 @@
-/// @mainpage LLVM
+/// \mainpage LLVM
 ///
-/// @section main_intro Introduction
+/// \section main_intro Introduction
 /// Welcome to LLVM.
 ///
-/// This documentation describes the @b internal software that makes 
-/// up LLVM, not the @b external use of  LLVM. There are no instructions
-/// here on how to use LLVM, only the APIs that make up the software. For usage 
+/// This documentation describes the **internal** software that makes
+/// up LLVM, not the **external** use of  LLVM. There are no instructions
+/// here on how to use LLVM, only the APIs that make up the software. For usage
 /// instructions, please see the programmer's guide or reference manual.
 ///
-/// @section main_caveat Caveat 
-/// This documentation is generated directly from the source code with doxygen. 
+/// \section main_caveat Caveat
+/// This documentation is generated directly from the source code with doxygen.
 /// Since LLVM is constantly under active development, what you're about to
 /// read is out of date! However, it may still be useful since certain portions
-/// of LLVM are very stable. 
+/// of LLVM are very stable.
 ///
-/// @section main_changelog Change Log
+/// \section main_changelog Change Log
 /// - Original content written 12/30/2003 by Reid Spencer

Modified: llvm/trunk/docs/doxygen.cfg.in
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/doxygen.cfg.in?rev=262786&r1=262785&r2=262786&view=diff
==============================================================================
--- llvm/trunk/docs/doxygen.cfg.in (original)
+++ llvm/trunk/docs/doxygen.cfg.in Sat Mar  5 21:50:08 2016
@@ -745,7 +745,7 @@ WARN_LOGFILE           =
 
 INPUT                  = @abs_top_srcdir@/include \
                          @abs_top_srcdir@/lib \
-                         @abs_top_srcdir@/docs/doxygen.intro
+                         @abs_top_srcdir@/docs/doxygen-mainpage.dox
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1791,18 +1791,6 @@ GENERATE_XML           = NO
 
 XML_OUTPUT             = xml
 
-# The XML_SCHEMA tag can be used to specify a XML schema, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_SCHEMA             =
-
-# The XML_DTD tag can be used to specify a XML DTD, which can be used by a
-# validating XML parser to check the syntax of the XML files.
-# This tag requires that the tag GENERATE_XML is set to YES.
-
-XML_DTD                =
-
 # If the XML_PROGRAMLISTING tag is set to YES doxygen will dump the program
 # listings (including syntax highlighting and cross-referencing information) to
 # the XML output. Note that enabling this will significantly increase the size
@@ -2071,7 +2059,7 @@ DOT_NUM_THREADS        = 0
 # The default value is: Helvetica.
 # This tag requires that the tag HAVE_DOT is set to YES.
 
-DOT_FONTNAME           = FreeSans
+DOT_FONTNAME           = Helvetica
 
 # The DOT_FONTSIZE tag can be used to set the size (in points) of the font of
 # dot graphs.

Removed: llvm/trunk/docs/doxygen.intro
URL: http://llvm.org/viewvc/llvm-project/llvm/trunk/docs/doxygen.intro?rev=262785&view=auto
==============================================================================
--- llvm/trunk/docs/doxygen.intro (original)
+++ llvm/trunk/docs/doxygen.intro (removed)
@@ -1,18 +0,0 @@
-/// @mainpage LLVM
-///
-/// @section main_intro Introduction
-/// Welcome to LLVM.
-///
-/// This documentation describes the @b internal software that makes 
-/// up LLVM, not the @b external use of  LLVM. There are no instructions
-/// here on how to use LLVM, only the APIs that make up the software. For usage 
-/// instructions, please see the programmer's guide or reference manual.
-///
-/// @section main_caveat Caveat 
-/// This documentation is generated directly from the source code with doxygen. 
-/// Since LLVM is constantly under active development, what you're about to
-/// read is out of date! However, it may still be useful since certain portions
-/// of LLVM are very stable. 
-///
-/// @section main_changelog Change Log
-/// - Original content written 12/30/2003 by Reid Spencer




More information about the llvm-commits mailing list