[llvm-commits] CVS: llvm/docs/doxygen.css doxygen.footer doxygen.header doxygen.intro doxygen.cfg

Chris Lattner lattner at cs.uiuc.edu
Wed Dec 31 00:48:01 PST 2003


Changes in directory llvm/docs:

doxygen.css added (r1.1)
doxygen.footer added (r1.1)
doxygen.header added (r1.1)
doxygen.intro added (r1.1)
doxygen.cfg updated: 1.6 -> 1.7

---
Log message:

Add a bunch of fine tunings that Reid contributed.  Thanks Reid!


---
Diffs of the changes:  (+132 -5)

Index: llvm/docs/doxygen.css
diff -c /dev/null llvm/docs/doxygen.css:1.1
*** /dev/null	Wed Dec 31 00:47:38 2003
--- llvm/docs/doxygen.css	Wed Dec 31 00:47:28 2003
***************
*** 0 ****
--- 1,84 ----
+ BODY { background: white; color: black; font-family: Verdana,Arial,sans-serif; }
+ H1 { text-align: center; }
+ H2 { text-align: center; }
+ H3 { text-align: center; }
+ CAPTION { font-weight: bold }
+ A.qindex {}
+ A.qindexRef {}
+ A.el { text-decoration: none; font-weight: bold }
+ A.elRef { font-weight: bold }
+ A.code { text-decoration: none; font-weight: normal; color: #4444ee }
+ A.codeRef { font-weight: normal; color: #4444ee }
+ A:link {
+         cursor: pointer;
+         text-decoration: none;
+         font-weight: bolder;
+ }
+ A:visited {
+         cursor: pointer;
+         text-decoration: underline;
+         font-weight: bolder;
+ }
+ A:hover {
+         cursor: pointer;
+         text-decoration: underline;
+         font-weight: bolder;
+ }
+ A:active {
+         cursor: pointer;
+         text-decoration: underline;
+         font-weight: bolder;
+         font-style: italic;
+ }
+ DL.el { margin-left: -1cm }
+ DIV.fragment { width: 100%; border: none; background-color: #eeeeee }
+ DIV.ah { background-color: black; font-weight: bold; color: #ffffff; margin-bottom: 3px; margin-top: 3px }
+ TD.md { background-color: #f2f2ff; font-weight: bold; }
+ TD.mdname1 { background-color: #f2f2ff; font-weight: bold; color: #602020; }
+ TD.mdname { background-color: #f2f2ff; font-weight: bold; color: #602020; width: 600px; }
+ DIV.groupHeader { margin-left: 16px; margin-top: 12px; margin-bottom: 6px; font-weight: bold }
+ DIV.groupText { margin-left: 16px; font-style: italic; font-size: smaller }
+ TD.indexkey { 
+    background-color: #eeeeff; 
+    font-weight: bold; 
+    padding-right  : 10px; 
+    padding-top    : 2px; 
+    padding-left   : 10px; 
+    padding-bottom : 2px; 
+    margin-left    : 0px; 
+    margin-right   : 0px; 
+    margin-top     : 2px; 
+    margin-bottom  : 2px  
+ }
+ TD.indexvalue { 
+    background-color: #eeeeff; 
+    font-style: italic; 
+    padding-right  : 10px; 
+    padding-top    : 2px; 
+    padding-left   : 10px; 
+    padding-bottom : 2px; 
+    margin-left    : 0px; 
+    margin-right   : 0px; 
+    margin-top     : 2px; 
+    margin-bottom  : 2px  
+ }
+ span.keyword       { color: #008000 }
+ span.keywordtype   { color: #604020 }
+ span.keywordflow   { color: #e08000 }
+ span.comment       { color: #800000 }
+ span.preprocessor  { color: #806020 }
+ span.stringliteral { color: #002080 }
+ span.charliteral   { color: #008080 }
+ 
+ .footer {
+         font-size: 80%;
+         font-weight: bold;
+         text-align: center;
+         vertical-align: middle;
+ }
+ .title {
+     font-size: 105%
+     font-weight: bold;
+     text-decoration: underline;
+     text-align: center;
+ }


Index: llvm/docs/doxygen.footer
diff -c /dev/null llvm/docs/doxygen.footer:1.1
*** /dev/null	Wed Dec 31 00:47:38 2003
--- llvm/docs/doxygen.footer	Wed Dec 31 00:47:28 2003
***************
*** 0 ****
--- 1,9 ----
+ <hr>
+ <p class="footer">
+ Generated on $datetime for $projectname version $projectnumber by
+ <a href="http://www.doxygen.org/index.html">doxygen $doxygenversion</a><br/>
+ Copyright © 2003, University of Illinois at Urbana-Champaign. All Rights Reserved.<br/>
+ <a href="/index.php" onmouseover="window.status='Go To LLVM Home Page';return true;" title="LLVM Home Page">Home Page</a>
+ <a href="http://www.doxygen.org/index.html" onmouseover="window.status='Go To Doxygen Home Page';return true;" title="Doxygen Home Page">
+ <img src="doxygen.png" alt="Doxygen Logo" style="border:none;"/></a> 
+ </p></body></html>


Index: llvm/docs/doxygen.header
diff -c /dev/null llvm/docs/doxygen.header:1.1
*** /dev/null	Wed Dec 31 00:47:38 2003
--- llvm/docs/doxygen.header	Wed Dec 31 00:47:28 2003
***************
*** 0 ****
--- 1,9 ----
+ <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
+ <html><head>
+ <meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"/>
+ <meta name="keywords" content="LLVM,Low Level Virtual Machine,C++,doxygen,API,documentation"/>
+ <meta name="description" content="C++ source code API documentation for the Low Level Virtual Machine (LLVM)."/>
+ <title>LLVM: $title</title>
+ <link href="doxygen.css" rel="stylesheet" type="text/css"/>
+ </head><body>
+ <p class="title">LLVM API Documentation</p>


Index: llvm/docs/doxygen.intro
diff -c /dev/null llvm/docs/doxygen.intro:1.1
*** /dev/null	Wed Dec 31 00:47:38 2003
--- llvm/docs/doxygen.intro	Wed Dec 31 00:47:28 2003
***************
*** 0 ****
--- 1,25 ----
+ ////////////////////////////////////////////////////////////////////////////////
+ /// @file doxygen.intro
+ /// @author Reid Spencer <rspencer at x10sys.com> 
+ /// @date 2003/12/30
+ /// @brief LLVM API documentation introduction.
+ ////////////////////////////////////////////////////////////////////////////////
+ ///
+ /// @mainpage LLVM:Low Level Virtual Machine
+ ///
+ /// @section main_intro Introduction
+ /// Welcome to the Low Level Virtual Machine (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


Index: llvm/docs/doxygen.cfg
diff -u llvm/docs/doxygen.cfg:1.6 llvm/docs/doxygen.cfg:1.7
--- llvm/docs/doxygen.cfg:1.6	Fri Oct 17 18:00:03 2003
+++ llvm/docs/doxygen.cfg	Wed Dec 31 00:47:28 2003
@@ -201,7 +201,7 @@
 # The TAB_SIZE tag can be used to set the number of spaces in a tab. 
 # Doxygen uses this value to replace tabs by spaces in code fragments.
 
-TAB_SIZE               = 8
+TAB_SIZE               = 2
 
 # The GENERATE_TODOLIST tag can be used to enable (YES) or 
 # disable (NO) the todo list. This list is created by putting \todo 
@@ -301,7 +301,7 @@
 # directories like "/usr/src/myproject". Separate the files or directories with
 # spaces.
 
-INPUT                  = ..
+INPUT                  = .. ./doxygen.intro
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -439,20 +439,20 @@
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard header.
 
-HTML_HEADER            = 
+HTML_HEADER            = doxygen.header
 
 # The HTML_FOOTER tag can be used to specify a personal HTML footer for 
 # each generated HTML page. If it is left blank doxygen will generate a 
 # standard footer.
 
-HTML_FOOTER            = 
+HTML_FOOTER            = doxygen.footer
 
 # The HTML_STYLESHEET tag can be used to specify a user defined cascading 
 # style sheet that is used by each HTML page. It can be used to 
 # fine-tune the look of the HTML output. If the tag is left blank doxygen 
 # will generate a default style sheet
 
-HTML_STYLESHEET        = 
+HTML_STYLESHEET        = doxygen.css
 
 # If the HTML_ALIGN_MEMBERS tag is set to YES, the members of classes, 
 # files or namespaces will be aligned in HTML using tables. If set to 





More information about the llvm-commits mailing list