[Lldb-commits] [lldb] r358773 - [Docs] Make Doxygen functional

Fri Apr 19 11:02:37 PDT 2019

Author: jdevlieghere
Date: Fri Apr 19 11:02:35 2019
New Revision: 358773

URL: http://llvm.org/viewvc/llvm-project?rev=358773&view=rev
Log:
[Docs] Make Doxygen functional

This fixes the doxygen configuration to be functional again. I removed
the customer header and footer, as well as the no-longer-existent style
sheet. I also widened the scope of the documentation, from just the
public API to include the private interfaces as well.

Added:
    lldb/trunk/docs/doxygen-mainpage.dox
Removed:
    lldb/trunk/docs/doxygen.footer
    lldb/trunk/docs/doxygen.header
    lldb/trunk/docs/doxygen.intro
Modified:
    lldb/trunk/docs/doxygen.cfg.in

Added: lldb/trunk/docs/doxygen-mainpage.dox
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/doxygen-mainpage.dox?rev=358773&view=auto
==============================================================================

--- lldb/trunk/docs/doxygen-mainpage.dox (added)
+++ lldb/trunk/docs/doxygen-mainpage.dox Fri Apr 19 11:02:35 2019
@@ -0,0 +1,15 @@
+/// @mainpage LLDB
+///
+/// @section main_intro Introduction
+/// Welcome to LLDB.
+///
+/// This documentation describes both the private and public interface of LLDB.
+/// There are no instructions here on how to use LLDB, only the APIs
+/// that make up the software. For usage instructions, please see
+/// the help command.
+///
+/// @section main_caveat Caveat
+/// This documentation is generated directly from the source code with doxygen.
+/// Since LLDB 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 LLDB are very stable.

Modified: lldb/trunk/docs/doxygen.cfg.in
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/doxygen.cfg.in?rev=358773&r1=358772&r2=358773&view=diff
==============================================================================
--- lldb/trunk/docs/doxygen.cfg.in (original)
+++ lldb/trunk/docs/doxygen.cfg.in Fri Apr 19 11:02:35 2019
@@ -25,7 +25,7 @@ DOXYFILE_ENCODING      = UTF-8
 # The PROJECT_NAME tag is a single word (or a sequence of words surrounded
 # by quotes) that should identify the project.
 
-PROJECT_NAME           = LLVM
+PROJECT_NAME           = LLDB
 
 # The PROJECT_NUMBER tag can be used to enter a project or revision number.
 # This could be handy for archiving the generated documentation or
@@ -581,8 +581,9 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = @abs_top_srcdir@/include/lldb/API \
-                         @abs_top_srcdir@/docs/doxygen.intro
+INPUT                  = @abs_top_srcdir@/include/ \
+                         @abs_top_srcdir@/source/ \
+                         @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, which is
@@ -793,13 +794,13 @@ HTML_FILE_EXTENSION    = .html
 # each generated HTML page. If it is left blank doxygen will generate a
 # standard header.
 
-HTML_HEADER            = @abs_top_srcdir@/docs/doxygen.header
+HTML_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            = @abs_top_srcdir@/docs/doxygen.footer
+HTML_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
@@ -808,7 +809,7 @@ HTML_FOOTER            = @abs_top_srcdir
 # the style sheet file to the HTML output directory, so don't put your own
 # stylesheet in the HTML output directory as well, or it will be erased!
 
-HTML_STYLESHEET        = @abs_top_srcdir@/../../docs/doxygen.css
+HTML_STYLESHEET        =
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output.
 # Doxygen will adjust the colors in the stylesheet and background images

Removed: lldb/trunk/docs/doxygen.footer
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/doxygen.footer?rev=358772&view=auto
==============================================================================
--- lldb/trunk/docs/doxygen.footer (original)
+++ lldb/trunk/docs/doxygen.footer (removed)
@@ -1,13 +0,0 @@
-<hr>
-<p class="footer">
-Generated on $datetime for <a href="http://lldb.llvm.org/">$projectname</a> by
-<a href="http://www.doxygen.org"><img src="doxygen.png" alt="Doxygen"
-align="middle" border="0"/>$doxygenversion</a><br>
-Copyright © 2003-2013 University of Illinois at Urbana-Champaign.
-All Rights Reserved.</p>
-
-<hr>
-<!--#include virtual="/attrib.incl" -->
-
-</body>
-</html>

Removed: lldb/trunk/docs/doxygen.header
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/doxygen.header?rev=358772&view=auto
==============================================================================
--- lldb/trunk/docs/doxygen.header (original)
+++ lldb/trunk/docs/doxygen.header (removed)
@@ -1,9 +0,0 @@
-<!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="LLDB,C++,doxygen,API,documentation"/>
-<meta name="description" content="C++ source code API documentation for LLDB."/>
-<title>LLVM: $title</title>
-<link href="doxygen.css" rel="stylesheet" type="text/css"/>
-</head><body>
-<p class="title">LLDB API Documentation</p>

Removed: lldb/trunk/docs/doxygen.intro
URL: http://llvm.org/viewvc/llvm-project/lldb/trunk/docs/doxygen.intro?rev=358772&view=auto
==============================================================================
--- lldb/trunk/docs/doxygen.intro (original)
+++ lldb/trunk/docs/doxygen.intro (removed)
@@ -1,19 +0,0 @@
-/// @mainpage LLDB
-///
-/// @section main_intro Introduction
-/// Welcome to LLDB.
-///
-/// This documentation describes the @b interface that can drive LLDB.
-/// There are no instructions here on how to use LLDB, only the APIs
-/// that make up the software. For usage instructions, please see
-/// the help command.
-///
-/// @section main_caveat Caveat 
-/// This documentation is generated directly from the source code with doxygen. 
-/// Since LLDB 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 LLDB are very stable. 
-///
-/// @section main_changelog Change Log
-/// - Adapted for LLDB 05/25/2013 by Daniel Malea
-/// - Original content written 12/30/2003 by Reid Spencer


