From b5bff9534fd09d15b11050037daf302e4381eb5a Mon Sep 17 00:00:00 2001 From: Dana Jansens Date: Mon, 4 Nov 2002 01:20:02 +0000 Subject: [PATCH] add doxygen to the project. 'make doc' builds the doxygen stuff. you need doxygen and graphviz installed to generate it properly --- Makefile.am | 5 + TODO | 3 + configure.ac | 1 + doc/Makefile.am | 2 +- doc/doxygen/.cvsignore | 4 + doc/doxygen/Makefile.am | 9 ++ doc/doxygen/doxygen.conf.in | 192 ++++++++++++++++++++++++++++++++++++ doc/doxygen/style.css | 53 ++++++++++ 8 files changed, 268 insertions(+), 1 deletion(-) create mode 100644 doc/doxygen/.cvsignore create mode 100644 doc/doxygen/Makefile.am create mode 100644 doc/doxygen/doxygen.conf.in create mode 100644 doc/doxygen/style.css diff --git a/Makefile.am b/Makefile.am index 7048d8f5..b964ab70 100644 --- a/Makefile.am +++ b/Makefile.am @@ -3,6 +3,11 @@ SUBDIRS = intl po m4 data doc otk src MAINTAINERCLEANFILES = aclocal.m4 config.h.in configure Makefile.in stamp-h.in +.PHONY: doc + +doc: + $(MAKE) -$(MAKEFLAGS) -C doc/doxygen doc + uninstall-local: -rmdir $(pkgdatadir) diff --git a/TODO b/TODO index 04cc84ef..a336af66 100644 --- a/TODO +++ b/TODO @@ -21,6 +21,9 @@ Goals for future releases of Openbox (THIS CAN AND WILL CHANGE): e.g. add _BLACKBOX_STYLE and _BLACKBOX_MENU atoms so that bbtools, bbconf, etc. can get the current path to the style in use and menu. +* keep track of what strings are Utf8 and what aren't and use the appropriate + functions! + 4.0: * have plugins/scripts for most everything as deemed appropriate. diff --git a/configure.ac b/configure.ac index 84535254..801d94dc 100644 --- a/configure.ac +++ b/configure.ac @@ -175,6 +175,7 @@ AC_CONFIG_FILES([Makefile util/Makefile util/epist/Makefile doc/Makefile + doc/doxygen/Makefile data/Makefile data/styles/Makefile version.h diff --git a/doc/Makefile.am b/doc/Makefile.am index 91ba8916..96a64f81 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -3,7 +3,7 @@ CLEANFILES = openbox.1 MAINTAINERCLEANFILES = Makefile.in man_MANS = openbox.1 bsetroot.1 bsetbg.1 xftlsfonts.1 -SUBDIRS = +SUBDIRS = doxygen DEFAULT_MENU=$(pkgdatadir)/menu diff --git a/doc/doxygen/.cvsignore b/doc/doxygen/.cvsignore new file mode 100644 index 00000000..f5fe6ad0 --- /dev/null +++ b/doc/doxygen/.cvsignore @@ -0,0 +1,4 @@ +Makefile +Makefile.in +html +doxygen.conf \ No newline at end of file diff --git a/doc/doxygen/Makefile.am b/doc/doxygen/Makefile.am new file mode 100644 index 00000000..0a09e70a --- /dev/null +++ b/doc/doxygen/Makefile.am @@ -0,0 +1,9 @@ +all: + +doc: doxygen.conf + @doxygen doxygen.conf + +doxygen.conf: doxygen.conf.in + @regex_cmd@ -e "s,\@VERSION\@,$(VERSION)," \ + -e "s,\@basedir\@,`cd $(top_builddir) && pwd`," \ + doxygen.conf.in > doxygen.conf diff --git a/doc/doxygen/doxygen.conf.in b/doc/doxygen/doxygen.conf.in new file mode 100644 index 00000000..8f2fea7e --- /dev/null +++ b/doc/doxygen/doxygen.conf.in @@ -0,0 +1,192 @@ +# Doxyfile 1.2.18 + +#--------------------------------------------------------------------------- +# General configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = Openbox +PROJECT_NUMBER = @VERSION@ +OUTPUT_DIRECTORY = +OUTPUT_LANGUAGE = English +EXTRACT_ALL = YES +EXTRACT_PRIVATE = YES +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = YES +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = NO +HIDE_FRIEND_COMPOUNDS = NO +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = YES +STRIP_FROM_PATH = @basedir@ +INTERNAL_DOCS = NO +STRIP_CODE_COMMENTS = NO +CASE_SENSE_NAMES = NO +SHORT_NAMES = NO +HIDE_SCOPE_NAMES = NO +VERBATIM_HEADERS = YES +SHOW_INCLUDE_FILES = YES +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +TAB_SIZE = 2 +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ALIASES = +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +SHOW_USED_FILES = YES +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = YES +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = ../../src ../../otk +FILE_PATTERNS = *.hh *.cc +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = YES +INLINE_SOURCES = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = NO +COLS_IN_ALPHA_INDEX = 5 +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- +GENERATE_HTML = YES +HTML_OUTPUT = html +HTML_FILE_EXTENSION = .html +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = style.css +HTML_ALIGN_MEMBERS = YES +GENERATE_HTMLHELP = NO +CHM_FILE = +HHC_LOCATION = +GENERATE_CHI = NO +BINARY_TOC = NO +TOC_EXPAND = NO +DISABLE_INDEX = NO +ENUM_VALUES_PER_LINE = 4 +GENERATE_TREEVIEW = NO +TREEVIEW_WIDTH = 250 +#--------------------------------------------------------------------------- +# configuration options related to the LaTeX output +#--------------------------------------------------------------------------- +GENERATE_LATEX = NO +LATEX_OUTPUT = latex +LATEX_CMD_NAME = latex +MAKEINDEX_CMD_NAME = makeindex +COMPACT_LATEX = NO +PAPER_TYPE = a4wide +EXTRA_PACKAGES = +LATEX_HEADER = +PDF_HYPERLINKS = NO +USE_PDFLATEX = NO +LATEX_BATCHMODE = NO +#--------------------------------------------------------------------------- +# configuration options related to the RTF output +#--------------------------------------------------------------------------- +GENERATE_RTF = NO +RTF_OUTPUT = rtf +COMPACT_RTF = NO +RTF_HYPERLINKS = NO +RTF_STYLESHEET_FILE = +RTF_EXTENSIONS_FILE = +#--------------------------------------------------------------------------- +# configuration options related to the man page output +#--------------------------------------------------------------------------- +GENERATE_MAN = NO +MAN_OUTPUT = man +MAN_EXTENSION = .3 +MAN_LINKS = NO +#--------------------------------------------------------------------------- +# configuration options related to the XML output +#--------------------------------------------------------------------------- +GENERATE_XML = NO +XML_SCHEMA = +XML_DTD = +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- +ENABLE_PREPROCESSING = YES +MACRO_EXPANSION = NO +EXPAND_ONLY_PREDEF = NO +SEARCH_INCLUDES = YES +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = +PREDEFINED = +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to external references +#--------------------------------------------------------------------------- +TAGFILES = +GENERATE_TAGFILE = +ALLEXTERNALS = NO +EXTERNAL_GROUPS = YES +PERL_PATH = /usr/bin/perl +#--------------------------------------------------------------------------- +# Configuration options related to the dot tool +#--------------------------------------------------------------------------- +CLASS_DIAGRAMS = YES +HIDE_UNDOC_RELATIONS = YES +HAVE_DOT = YES +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +TEMPLATE_RELATIONS = YES +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +GRAPHICAL_HIERARCHY = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::addtions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO +CGI_NAME = search.cgi +CGI_URL = +DOC_URL = +DOC_ABSPATH = +BIN_ABSPATH = /usr/local/bin/ +EXT_DOC_PATHS = diff --git a/doc/doxygen/style.css b/doc/doxygen/style.css new file mode 100644 index 00000000..27606a47 --- /dev/null +++ b/doc/doxygen/style.css @@ -0,0 +1,53 @@ +body {background : #5a6975} + +a {color : #9aacbb; font : medium "Helvetica", sans-serif} +a:visited {color : #143e65} +a:hover {color : #b9ccdb} + +H1 { 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 } +DL.el { margin-left: -1cm } +DIV.fragment { width: 100%; border: none; background-color: #6a7985 } +DIV.ah { background-color: black; font-weight: bold; color: #8a99a5; margin-bottom: 3px; margin-top: 3px } +TD.md { background-color: #7a8995; font-weight: bold; } +TD.mdname1 { background-color: #7a8995; font-weight: bold; color: #602020; } +TD.mdname { background-color: #7a8995; 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: #6a7985; + 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: #6a7985; + 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 } -- 2.39.2