From 7e0a02c604ffe574f8c88b83229b7230f529171d Mon Sep 17 00:00:00 2001 From: Binh-Minh Ribler Date: Sat, 28 May 2005 22:51:47 -0500 Subject: [svn-r10823] Purpose: Adding files for C++ API RM Description: cpp_doc_config is the configuration file, used by Doxygen to generate the RM. RM_stylesheet.css is the style sheet used by the RM html pages; this style sheet is a modified version from the default doxygen.css. header.html and header_files are input to produce different page header than the default. Platforms tested: Verified on Windows XP. --- c++/src/RM_stylesheet.css | 450 ++++++++++++++++++++++++++++++++++++++ c++/src/cpp_doc_config | 221 +++++++++++++++++++ c++/src/header.html | 322 +++++++++++++++++++++++++++ c++/src/header_files/filelist.xml | 6 + c++/src/header_files/image001.jpg | Bin 0 -> 3034 bytes c++/src/header_files/image002.jpg | Bin 0 -> 2010 bytes 6 files changed, 999 insertions(+) create mode 100644 c++/src/RM_stylesheet.css create mode 100644 c++/src/cpp_doc_config create mode 100644 c++/src/header.html create mode 100644 c++/src/header_files/filelist.xml create mode 100644 c++/src/header_files/image001.jpg create mode 100644 c++/src/header_files/image002.jpg diff --git a/c++/src/RM_stylesheet.css b/c++/src/RM_stylesheet.css new file mode 100644 index 0000000..5d3f93b --- /dev/null +++ b/c++/src/RM_stylesheet.css @@ -0,0 +1,450 @@ +BODY +{ +} +H1 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H2 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H3 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H4 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H5 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H6 +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +P +{ +} +CENTER +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +TD +{ +} +TH +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +UL +{ +} +DL +{ +} +DIV +{ + FONT-FAMILY: Geneva, Arial, Helvetica, sans-serif +} +H1 +{ + TEXT-ALIGN: center +} +CAPTION +{ + FONT-WEIGHT: bold +} +DIV.qindex +{ + BORDER-RIGHT: #b0b0b0 1px solid; + PADDING-RIGHT: 2px; + BORDER-TOP: #b0b0b0 1px solid; + PADDING-LEFT: 2px; + PADDING-BOTTOM: 2px; + MARGIN: 2px; + BORDER-LEFT: #b0b0b0 1px solid; + WIDTH: 100%; + LINE-HEIGHT: 140%; + PADDING-TOP: 2px; + BORDER-BOTTOM: #b0b0b0 1px solid; + BACKGROUND-COLOR: #eeeeff; + TEXT-ALIGN: center +} +DIV.nav +{ + BORDER-RIGHT: #b0b0b0 1px solid; + PADDING-RIGHT: 2px; + BORDER-TOP: #b0b0b0 1px solid; + PADDING-LEFT: 2px; + PADDING-BOTTOM: 2px; + MARGIN: 2px; + BORDER-LEFT: #b0b0b0 1px solid; + WIDTH: 100%; + LINE-HEIGHT: 140%; + PADDING-TOP: 2px; + BORDER-BOTTOM: #b0b0b0 1px solid; + BACKGROUND-COLOR: #eeeeff; + TEXT-ALIGN: center +} +A.qindex +{ + FONT-WEIGHT: bold; + COLOR: #1a419d; + TEXT-DECORATION: none +} +A.qindex:visited +{ + FONT-WEIGHT: bold; + COLOR: #1a419d; + TEXT-DECORATION: none +} +A.qindex:hover +{ + BACKGROUND-COLOR: #ddddff; + TEXT-DECORATION: none +} +A.qindexHL +{ + BORDER-RIGHT: #9295c2 1px double; + BORDER-TOP: #9295c2 1px double; + FONT-WEIGHT: bold; + BORDER-LEFT: #9295c2 1px double; + COLOR: #ffffff; + BORDER-BOTTOM: #9295c2 1px double; + BACKGROUND-COLOR: #6666cc; + TEXT-DECORATION: none +} +A.qindexHL:hover +{ + COLOR: #ffffff; + BACKGROUND-COLOR: #6666cc; + TEXT-DECORATION: none +} +A.qindexHL:visited +{ + COLOR: #ffffff; + BACKGROUND-COLOR: #6666cc; + TEXT-DECORATION: none +} +A.el +{ + FONT-WEIGHT: bold; + TEXT-DECORATION: none +} +A.elRef +{ + FONT-WEIGHT: bold +} +A.code:link +{ + FONT-WEIGHT: normal; + COLOR: #0000ff; + TEXT-DECORATION: none +} +A.code:visited +{ + FONT-WEIGHT: normal; + COLOR: #0000ff; + TEXT-DECORATION: none +} +A.codeRef:link +{ + FONT-WEIGHT: normal; + COLOR: #0000ff +} +A.codeRef:visited +{ + FONT-WEIGHT: normal; + COLOR: #0000ff +} +A:hover +{ + BACKGROUND-COLOR: #f2f2ff; + TEXT-DECORATION: none +} +DL.el +{ + MARGIN-LEFT: -1cm +} +.fragment +{ + FONT-FAMILY: monospace +} +PRE.fragment +{ + BORDER-RIGHT: #cccccc 1px solid; + PADDING-RIGHT: 6px; + BORDER-TOP: #cccccc 1px solid; + PADDING-LEFT: 6px; + PADDING-BOTTOM: 4px; + MARGIN: 4px 8px 4px 2px; + BORDER-LEFT: #cccccc 1px solid; + PADDING-TOP: 4px; + BORDER-BOTTOM: #cccccc 1px solid; + BACKGROUND-COLOR: #f5f5f5 +} +DIV.ah +{ + MARGIN-TOP: 3px; + FONT-WEIGHT: bold; + MARGIN-BOTTOM: 3px; + COLOR: #ffffff; + BACKGROUND-COLOR: black +} +TD.md +{ + FONT-WEIGHT: bold; + BACKGROUND-COLOR: #f4f4fb +} +TD.mdname1 +{ + FONT-WEIGHT: bold; + COLOR: #602020; + BACKGROUND-COLOR: #f4f4fb +} +TD.mdname +{ + FONT-WEIGHT: bold; + WIDTH: 600px; + COLOR: #602020; + BACKGROUND-COLOR: #f4f4fb +} +DIV.groupHeader +{ + MARGIN-TOP: 12px; + FONT-WEIGHT: bold; + MARGIN-BOTTOM: 6px; + MARGIN-LEFT: 16px +} +DIV.groupText +{ + FONT-SIZE: 14px; + MARGIN-LEFT: 16px; + FONT-STYLE: italic +} +BODY +{ + BACKGROUND: white; + MARGIN-LEFT: 20px; + COLOR: black; + MARGIN-RIGHT: 20px +} +TD.indexkey +{ + BORDER-RIGHT: #cccccc 1px solid; + PADDING-RIGHT: 10px; + BORDER-TOP: #cccccc 1px solid; + PADDING-LEFT: 10px; + FONT-WEIGHT: bold; + PADDING-BOTTOM: 2px; + MARGIN: 2px 0px; + BORDER-LEFT: #cccccc 1px solid; + PADDING-TOP: 2px; + BORDER-BOTTOM: #cccccc 1px solid; + BACKGROUND-COLOR: #eeeeff +} +TD.indexvalue +{ + BORDER-RIGHT: #cccccc 1px solid; + PADDING-RIGHT: 10px; + BORDER-TOP: #cccccc 1px solid; + PADDING-LEFT: 10px; + PADDING-BOTTOM: 2px; + MARGIN: 2px 0px; + BORDER-LEFT: #cccccc 1px solid; + PADDING-TOP: 2px; + BORDER-BOTTOM: #cccccc 1px solid; + FONT-STYLE: italic; + BACKGROUND-COLOR: #eeeeff +} +TR.memlist +{ + BACKGROUND-COLOR: #f0f0f0 +} +P.formulaDsp +{ + TEXT-ALIGN: center +} +IMG.formulaDsp +{ +} +IMG.formulaInl +{ + VERTICAL-ALIGN: middle +} +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 +} +.mdTable +{ + BORDER-RIGHT: #868686 1px solid; + BORDER-TOP: #868686 1px solid; + BORDER-LEFT: #868686 1px solid; + BORDER-BOTTOM: #868686 1px solid; + BACKGROUND-COLOR: #f4f4fb +} +.mdRow +{ + PADDING-RIGHT: 10px; + PADDING-LEFT: 10px; + PADDING-BOTTOM: 8px; + PADDING-TOP: 8px +} +.mdescLeft +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 8px; + BORDER-TOP: #e0e0e0 1px; + PADDING-LEFT: 8px; + FONT-SIZE: 12px; + PADDING-BOTTOM: 4px; + MARGIN: 0px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 0px; + BORDER-BOTTOM: #e0e0e0 1px; + FONT-STYLE: italic; + BACKGROUND-COLOR: #fafafa +} +.mdescRight +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 8px; + BORDER-TOP: #e0e0e0 1px; + PADDING-LEFT: 8px; + FONT-SIZE: 12px; + PADDING-BOTTOM: 4px; + MARGIN: 0px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 0px; + BORDER-BOTTOM: #e0e0e0 1px; + FONT-STYLE: italic; + BACKGROUND-COLOR: #fafafa +} +.memItemLeft +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 0px; + BORDER-TOP: #e0e0e0 1px solid; + PADDING-LEFT: 8px; + FONT-SIZE: 12px; + PADDING-BOTTOM: 0px; + MARGIN: 4px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 1px; + BORDER-BOTTOM: #e0e0e0 1px; + BACKGROUND-COLOR: #fafafa +} +.memItemRight +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 8px; + BORDER-TOP: #e0e0e0 1px solid; + PADDING-LEFT: 8px; + FONT-SIZE: 13px; + PADDING-BOTTOM: 0px; + MARGIN: 4px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 1px; + BORDER-BOTTOM: #e0e0e0 1px; + BACKGROUND-COLOR: #fafafa +} +.memTemplItemLeft +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 0px; + BORDER-TOP: #e0e0e0 1px; + PADDING-LEFT: 8px; + FONT-SIZE: 12px; + PADDING-BOTTOM: 0px; + MARGIN: 4px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 1px; + BORDER-BOTTOM: #e0e0e0 1px; + BACKGROUND-COLOR: #fafafa +} +.memTemplItemRight +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 8px; + BORDER-TOP: #e0e0e0 1px; + PADDING-LEFT: 8px; + FONT-SIZE: 13px; + PADDING-BOTTOM: 0px; + MARGIN: 4px; + BORDER-LEFT: #e0e0e0 1px; + PADDING-TOP: 1px; + BORDER-BOTTOM: #e0e0e0 1px; + BACKGROUND-COLOR: #fafafa +} +.memTemplParams +{ + BORDER-RIGHT: #e0e0e0 1px; + PADDING-RIGHT: 0px; + BORDER-TOP: #e0e0e0 1px solid; + PADDING-LEFT: 8px; + FONT-SIZE: 12px; + PADDING-BOTTOM: 0px; + MARGIN: 4px; + BORDER-LEFT: #e0e0e0 1px; + COLOR: #606060; + PADDING-TOP: 1px; + BORDER-BOTTOM: #e0e0e0 1px; + BACKGROUND-COLOR: #fafafa +} +.search +{ + FONT-WEIGHT: bold; + COLOR: #003399 +} +FORM.search +{ + MARGIN-TOP: 0px; + MARGIN-BOTTOM: 0px +} +INPUT.search +{ + FONT-WEIGHT: normal; + FONT-SIZE: 75%; + COLOR: #000080; + BACKGROUND-COLOR: #eeeeff +} +TD.tiny +{ + FONT-SIZE: 75% +} +A +{ + COLOR: #252e78 +} +A:visited +{ + COLOR: #3d2185 +} diff --git a/c++/src/cpp_doc_config b/c++/src/cpp_doc_config new file mode 100644 index 0000000..057fe69 --- /dev/null +++ b/c++/src/cpp_doc_config @@ -0,0 +1,221 @@ +# Doxyfile 1.4.2 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- +PROJECT_NAME = +PROJECT_NUMBER = +OUTPUT_DIRECTORY = ../../doc/html/cpplus_RM/ +CREATE_SUBDIRS = NO +OUTPUT_LANGUAGE = English +USE_WINDOWS_ENCODING = YES +BRIEF_MEMBER_DESC = YES +REPEAT_BRIEF = YES +ABBREVIATE_BRIEF = +ALWAYS_DETAILED_SEC = NO +INLINE_INHERITED_MEMB = NO +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = +SHORT_NAMES = NO +JAVADOC_AUTOBRIEF = NO +MULTILINE_CPP_IS_BRIEF = NO +DETAILS_AT_TOP = NO +INHERIT_DOCS = YES +DISTRIBUTE_GROUP_DOC = NO +SEPARATE_MEMBER_PAGES = NO +TAB_SIZE = 8 +ALIASES = +OPTIMIZE_OUTPUT_FOR_C = NO +OPTIMIZE_OUTPUT_JAVA = NO +SUBGROUPING = YES +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- +EXTRACT_ALL = YES +EXTRACT_PRIVATE = NO +EXTRACT_STATIC = YES +EXTRACT_LOCAL_CLASSES = NO +EXTRACT_LOCAL_METHODS = NO +HIDE_UNDOC_MEMBERS = YES +HIDE_UNDOC_CLASSES = YES +HIDE_FRIEND_COMPOUNDS = NO +HIDE_IN_BODY_DOCS = NO +INTERNAL_DOCS = YES +CASE_SENSE_NAMES = YES +HIDE_SCOPE_NAMES = NO +SHOW_INCLUDE_FILES = YES +INLINE_INFO = YES +SORT_MEMBER_DOCS = NO +SORT_BRIEF_DOCS = NO +SORT_BY_SCOPE_NAME = NO +GENERATE_TODOLIST = YES +GENERATE_TESTLIST = YES +GENERATE_BUGLIST = YES +GENERATE_DEPRECATEDLIST= YES +ENABLED_SECTIONS = +MAX_INITIALIZER_LINES = 30 +SHOW_USED_FILES = NO +SHOW_DIRECTORIES = YES +FILE_VERSION_FILTER = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- +QUIET = NO +WARNINGS = YES +WARN_IF_UNDOCUMENTED = YES +WARN_IF_DOC_ERROR = YES +WARN_NO_PARAMDOC = NO +WARN_FORMAT = "$file:$line: $text" +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- +INPUT = +FILE_PATTERNS = +RECURSIVE = NO +EXCLUDE = +EXCLUDE_SYMLINKS = NO +EXCLUDE_PATTERNS = +EXAMPLE_PATH = ../examples +EXAMPLE_PATTERNS = +EXAMPLE_RECURSIVE = NO +IMAGE_PATH = +INPUT_FILTER = +FILTER_PATTERNS = +FILTER_SOURCE_FILES = NO +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- +SOURCE_BROWSER = NO +INLINE_SOURCES = NO +STRIP_CODE_COMMENTS = YES +REFERENCED_BY_RELATION = YES +REFERENCES_RELATION = YES +VERBATIM_HEADERS = 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_FILE_EXTENSION = .html +HTML_HEADER = header.html +HTML_FOOTER = +HTML_STYLESHEET = RM_stylesheet.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 +LATEX_HIDE_INDICES = 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_OUTPUT = xml +XML_SCHEMA = +XML_DTD = +XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# configuration options for the AutoGen Definitions output +#--------------------------------------------------------------------------- +GENERATE_AUTOGEN_DEF = NO +#--------------------------------------------------------------------------- +# configuration options related to the Perl module output +#--------------------------------------------------------------------------- +GENERATE_PERLMOD = NO +PERLMOD_LATEX = NO +PERLMOD_PRETTY = YES +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# 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 = DOXYGEN_SHOULD_SKIP_THIS +EXPAND_AS_DEFINED = +SKIP_FUNCTION_MACROS = YES +#--------------------------------------------------------------------------- +# Configuration::additions 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 = NO +CLASS_GRAPH = YES +COLLABORATION_GRAPH = YES +GROUP_GRAPHS = YES +UML_LOOK = NO +TEMPLATE_RELATIONS = NO +INCLUDE_GRAPH = YES +INCLUDED_BY_GRAPH = YES +CALL_GRAPH = NO +GRAPHICAL_HIERARCHY = YES +DIRECTORY_GRAPH = YES +DOT_IMAGE_FORMAT = png +DOT_PATH = +DOTFILE_DIRS = +MAX_DOT_GRAPH_WIDTH = 1024 +MAX_DOT_GRAPH_HEIGHT = 1024 +MAX_DOT_GRAPH_DEPTH = 0 +DOT_TRANSPARENT = NO +DOT_MULTI_TARGETS = NO +GENERATE_LEGEND = YES +DOT_CLEANUP = YES +#--------------------------------------------------------------------------- +# Configuration::additions related to the search engine +#--------------------------------------------------------------------------- +SEARCHENGINE = NO diff --git a/c++/src/header.html b/c++/src/header.html new file mode 100644 index 0000000..8d84bbc --- /dev/null +++ b/c++/src/header.html @@ -0,0 +1,322 @@ + + + + + + + + + + + +Main Page + + + + + + + + + + +
+ +

 

+ +
+ + + + + +
+

HDF5 C++ API Reference Manual

+
+ +
+ +

 

+ +

 

+ +

 

+ +
+ + + + diff --git a/c++/src/header_files/filelist.xml b/c++/src/header_files/filelist.xml new file mode 100644 index 0000000..6732f49 --- /dev/null +++ b/c++/src/header_files/filelist.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/c++/src/header_files/image001.jpg b/c++/src/header_files/image001.jpg new file mode 100644 index 0000000..92b53c9 Binary files /dev/null and b/c++/src/header_files/image001.jpg differ diff --git a/c++/src/header_files/image002.jpg b/c++/src/header_files/image002.jpg new file mode 100644 index 0000000..e6f4804 Binary files /dev/null and b/c++/src/header_files/image002.jpg differ -- cgit v0.12