mirror of
https://github.com/boostorg/circular_buffer.git
synced 2026-02-13 00:12:12 +00:00
Full merge from trunk at revision 41356 of entire boost-root tree.
[SVN r41369]
This commit is contained in:
Beman Dawes
227
doc/Doxyfile
227
doc/Doxyfile
@@ -1,227 +0,0 @@
|
||||
# Doxygen configuration file.
|
||||
#
|
||||
# Copyright (c) 2003-2007 Jan Gaspar
|
||||
#
|
||||
# Distributed under the Boost Software License, Version 1.0. (See
|
||||
# accompanying file LICENSE_1_0.txt or copy at
|
||||
# http://www.boost.org/LICENSE_1_0.txt)
|
||||
#
|
||||
#---------------------------------------------------------------------------
|
||||
# Project related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
PROJECT_NAME = "Circular Buffer"
|
||||
PROJECT_NUMBER = 3.7
|
||||
OUTPUT_DIRECTORY = srcdoc
|
||||
CREATE_SUBDIRS = NO
|
||||
OUTPUT_LANGUAGE = English
|
||||
USE_WINDOWS_ENCODING = NO
|
||||
BRIEF_MEMBER_DESC = YES
|
||||
REPEAT_BRIEF = YES
|
||||
ABBREVIATE_BRIEF =
|
||||
ALWAYS_DETAILED_SEC = YES
|
||||
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
|
||||
TAB_SIZE = 8
|
||||
ALIASES =
|
||||
OPTIMIZE_OUTPUT_FOR_C = NO
|
||||
OPTIMIZE_OUTPUT_JAVA = NO
|
||||
SUBGROUPING = YES
|
||||
#---------------------------------------------------------------------------
|
||||
# Build related configuration options
|
||||
#---------------------------------------------------------------------------
|
||||
EXTRACT_ALL = YES
|
||||
EXTRACT_PRIVATE = YES
|
||||
EXTRACT_STATIC = YES
|
||||
EXTRACT_LOCAL_CLASSES = YES
|
||||
EXTRACT_LOCAL_METHODS = NO
|
||||
HIDE_UNDOC_MEMBERS = NO
|
||||
HIDE_UNDOC_CLASSES = NO
|
||||
HIDE_FRIEND_COMPOUNDS = NO
|
||||
HIDE_IN_BODY_DOCS = YES
|
||||
INTERNAL_DOCS = NO
|
||||
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 = YES
|
||||
WARN_FORMAT = "$file:$line: $text"
|
||||
WARN_LOGFILE =
|
||||
#---------------------------------------------------------------------------
|
||||
# configuration options related to the input files
|
||||
#---------------------------------------------------------------------------
|
||||
INPUT = ../../../boost/circular_buffer
|
||||
FILE_PATTERNS = *.hpp
|
||||
RECURSIVE = YES
|
||||
EXCLUDE = ../../../boost/circular_buffer/debug.hpp \
|
||||
../../../boost/circular_buffer/details.hpp
|
||||
EXCLUDE_SYMLINKS = NO
|
||||
EXCLUDE_PATTERNS =
|
||||
EXAMPLE_PATH =
|
||||
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 = NO
|
||||
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 = NO
|
||||
HTML_OUTPUT = html
|
||||
HTML_FILE_EXTENSION = .html
|
||||
HTML_HEADER =
|
||||
HTML_FOOTER =
|
||||
HTML_STYLESHEET =
|
||||
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 = YES
|
||||
XML_OUTPUT = .
|
||||
XML_SCHEMA =
|
||||
XML_DTD =
|
||||
XML_PROGRAMLISTING = NO
|
||||
#---------------------------------------------------------------------------
|
||||
# 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 = NO
|
||||
MACRO_EXPANSION = NO
|
||||
EXPAND_ONLY_PREDEF = NO
|
||||
SEARCH_INCLUDES = YES
|
||||
INCLUDE_PATH =
|
||||
INCLUDE_FILE_PATTERNS =
|
||||
PREDEFINED =
|
||||
EXPAND_AS_DEFINED =
|
||||
SKIP_FUNCTION_MACROS = YES
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration::additions related to external references
|
||||
#---------------------------------------------------------------------------
|
||||
TAGFILES =
|
||||
GENERATE_TAGFILE =
|
||||
ALLEXTERNALS = NO
|
||||
EXTERNAL_GROUPS = NO
|
||||
PERL_PATH =
|
||||
#---------------------------------------------------------------------------
|
||||
# Configuration options related to the dot tool
|
||||
#---------------------------------------------------------------------------
|
||||
CLASS_DIAGRAMS = NO
|
||||
HIDE_UNDOC_RELATIONS = NO
|
||||
HAVE_DOT = NO
|
||||
CLASS_GRAPH = YES
|
||||
COLLABORATION_GRAPH = YES
|
||||
GROUP_GRAPHS = YES
|
||||
UML_LOOK = NO
|
||||
TEMPLATE_RELATIONS = YES
|
||||
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
|
||||
@@ -1,52 +0,0 @@
|
||||
################################################################################
|
||||
# HOW-TO documentation about generating/updating source code documentation for #
|
||||
# the Circular Buffer library. #
|
||||
# #
|
||||
# Copyright (c) 2007 Jan Gaspar #
|
||||
# #
|
||||
# Use, modification, and distribution is subject to the Boost Software #
|
||||
# License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at #
|
||||
# http://www.boost.org/LICENSE_1_0.txt) #
|
||||
################################################################################
|
||||
|
||||
The source code documentation (i.e. documentation of functions, classes and
|
||||
their methods, etc.) is part of the source code. This makes it convenient for
|
||||
a developer when browsing source files or developing new (documented) code.
|
||||
The source code documentation is included in the larger, more detailed library
|
||||
documentation as well which makes it more convenient for the user of the
|
||||
library. In order to make it easier for the developer, the source code
|
||||
documentation included in the library documentation is generated from the source
|
||||
files. Which means the developer does not have to write the same source
|
||||
documentation twice.
|
||||
|
||||
Prerequisites:
|
||||
|
||||
1) Unix/Linux shell (with sed editor) available.
|
||||
(The script can be easily converted into Windows batch file if you do not
|
||||
have access to Unix/Linux shell.)
|
||||
2) Installed Doxygen http://www.doxygen.org.
|
||||
(Source documentation generation was tested with the Doxygen version
|
||||
1.4.6.)
|
||||
3) Installed xsltproc http://xmlsoft.org/XSLT/xsltproc2.html.
|
||||
4) Installed HTML Tidy http://tidy.sourceforge.net. (Tested with version
|
||||
released on 1 September 2005.)
|
||||
|
||||
|
||||
Updating source code documentation:
|
||||
|
||||
The source code documentation of the Circular Buffer library obeys the Doxygen
|
||||
syntax. The library documentation is written in HTML (files circular_buffer.html
|
||||
and space_optimized.html). The generation of the source code documentation is
|
||||
performed by executing the update_srcdoc.sh script which relies mainly on
|
||||
Doxygen and several XSL transformations.
|
||||
|
||||
After editing the source code documentation in the source file(s), update the
|
||||
library documentation by executing:
|
||||
|
||||
$>./update_srcdoc.sh circular_buffer
|
||||
|
||||
for the circular_buffer or/and
|
||||
|
||||
$>./update_srcdoc.sh circular_buffer_space_optimized
|
||||
|
||||
for the circular_buffer_space_optimized.
|
||||
@@ -1,18 +0,0 @@
|
||||
# HTML Tidy configuration file.
|
||||
#
|
||||
# Copyright (c) 2003-2007 Jan Gaspar
|
||||
#
|
||||
# Distributed under the Boost Software License, Version 1.0. (See
|
||||
# accompanying file LICENSE_1_0.txt or copy at
|
||||
# http://www.boost.org/LICENSE_1_0.txt)
|
||||
#
|
||||
bare: yes
|
||||
char-encoding: latin1
|
||||
doctype: transitional
|
||||
indent: yes
|
||||
indent-attributes: no
|
||||
quiet: yes
|
||||
show-warnings: no
|
||||
tidy-mark: no
|
||||
wrap: 120
|
||||
write-back: yes
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 21 KiB |
@@ -1,68 +0,0 @@
|
||||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!--
|
||||
XSL transformation from the XML files generated by Doxygen into XHTML source
|
||||
code documentation of the circular_buffer.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:import href="doxygen2html.xslt"/>
|
||||
|
||||
<xsl:output method="xml" version="1.0" encoding="iso-8859-1" indent="yes" media-type="text/xml"/>
|
||||
|
||||
<xsl:variable name="link-prefix" select="''"/>
|
||||
<xsl:variable name="standalone-functions" select="document(concat($xmldir, '/namespaceboost.xml'))/doxygen/compounddef/sectiondef[@kind='func']"/>
|
||||
|
||||
<xsl:template name="reference">
|
||||
<xsl:value-of select="concat('#', @refid)"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="template-parameters">
|
||||
<xsl:apply-templates select="templateparamlist/param" mode="synopsis"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="public-types">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-type']/memberdef" mode="synopsis"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="constructors">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-func']/memberdef[type = '']" mode="synopsis"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="member-functions">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-func']/memberdef[type != '']" mode="synopsis"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="standalone-functions">
|
||||
<xsl:apply-templates select="$standalone-functions/memberdef[contains(argsstring, 'circular_buffer<')]" mode="synopsis">
|
||||
<xsl:with-param name="indent" select="''"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="template-parameters-details">
|
||||
<xsl:apply-templates select="detaileddescription//parameterlist[@kind='param']/parameteritem" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="public-types-details">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-type']/memberdef" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="constructors-details">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-func']/memberdef[type = '']" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="member-functions-details">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-func']/memberdef[type != '']" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="standalone-functions-details">
|
||||
<xsl:apply-templates select="$standalone-functions/memberdef[contains(argsstring, 'circular_buffer<')]" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@@ -1,20 +0,0 @@
|
||||
<?xml version="1.0" encoding="iso-8859-1"?>
|
||||
<!--
|
||||
Helper XSL transformation making plain copy of an XML tree.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:template match="/ | node() | @* | comment() | processing-instruction()">
|
||||
<xsl:copy>
|
||||
<xsl:apply-templates select="@* | node()"/>
|
||||
</xsl:copy>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@@ -1,363 +0,0 @@
|
||||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!--
|
||||
Generic XSL transformation from the XML files generated by Doxygen into XHTML
|
||||
source code documentation.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<!DOCTYPE stylesheet [
|
||||
<!ENTITY nbsp " ">
|
||||
<!ENTITY space " ">
|
||||
]>
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:param name="container"/>
|
||||
<xsl:param name="xmldir"/>
|
||||
<xsl:variable name="container-ref" select="//compound[name=concat('boost::', $container) and @kind='class']/@refid"/>
|
||||
<xsl:variable name="class-file" select="concat($xmldir, '/', $container-ref, '.xml')"/>
|
||||
<xsl:variable name="class" select="document($class-file)/doxygen/compounddef[@id = $container-ref]"/>
|
||||
|
||||
<xsl:template match="/">
|
||||
<html>
|
||||
<header><title>Source Code Documentation</title></header>
|
||||
<body>
|
||||
<xsl:apply-templates select="$class" mode="synopsis"/>
|
||||
<xsl:apply-templates select="$class" mode="description"/>
|
||||
</body>
|
||||
</html>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="nonbreakablespace">
|
||||
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="bold">
|
||||
<b><xsl:apply-templates/></b>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="emphasis">
|
||||
<i><xsl:apply-templates/></i>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="linebreak">
|
||||
<br />
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="preformatted">
|
||||
<pre><xsl:apply-templates/></pre>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="computeroutput">
|
||||
<code><xsl:apply-templates/></code>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="para">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="ref">
|
||||
<xsl:variable name="link-text" select="substring-after(text(), concat($container, '::'))"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="string-length($link-text) > 0">
|
||||
<xsl:element name="a">
|
||||
<xsl:attribute name="href"><xsl:call-template name="reference"/></xsl:attribute>
|
||||
<xsl:value-of select="$link-text"/>
|
||||
</xsl:element>
|
||||
</xsl:when>
|
||||
<xsl:when test="text() = $container">
|
||||
<xsl:value-of select="text()"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:element name="a">
|
||||
<xsl:choose>
|
||||
<xsl:when test="count(//memberdef[@id=current()/@refid]) > 0">
|
||||
<xsl:attribute name="href"><xsl:value-of select="concat('#', @refid)"/></xsl:attribute>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:attribute name="href"><xsl:value-of select="concat($link-prefix, '#', @refid)"/></xsl:attribute>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
<xsl:value-of select="text()"/>
|
||||
</xsl:element>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="ulink">
|
||||
<a href="{@url}"><xsl:apply-templates/></a>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="parameteritem">
|
||||
<xsl:param name="desc" select="''"/>
|
||||
<xsl:param name="style" select="'code'"/>
|
||||
<xsl:if test="$desc != ''">
|
||||
<dt><b><xsl:value-of select="$desc"/></b></dt>
|
||||
</xsl:if>
|
||||
<dd>
|
||||
<xsl:choose>
|
||||
<xsl:when test="$style = 'code'">
|
||||
<dl compact="yes">
|
||||
<dt><code><xsl:apply-templates select="parameternamelist/parametername"/></code></dt>
|
||||
<dd><xsl:apply-templates select="parameterdescription"/></dd>
|
||||
</dl>
|
||||
</xsl:when>
|
||||
<xsl:when test="contains(parameternamelist/parametername, '<code>')">
|
||||
<code><xsl:value-of select="substring-before(substring-after(parameternamelist/parametername, '<code>'), '</code>')"/></code>
|
||||
<xsl:apply-templates select="parameterdescription"/>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:apply-templates select="parameternamelist/parametername"/>
|
||||
<xsl:apply-templates select="parameterdescription"/>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</dd>
|
||||
<xsl:apply-templates select="following-sibling::parameteritem[1]">
|
||||
<xsl:with-param name="style" select="$style"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='return']">
|
||||
<dl><dt><b>Returns:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='pre']">
|
||||
<dl><dt><b>Precondition:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='post']">
|
||||
<dl><dt><b>Effect:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='par']">
|
||||
<dl><dt><b><xsl:value-of select="title"/>:</b></dt><dd><xsl:apply-templates select="para"/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='warning']">
|
||||
<dl><dt><b>Warning:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='note']">
|
||||
<dl><dt><b>Note:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="simplesect[@kind='see']">
|
||||
<dl><dt><b>See Also:</b></dt><dd><xsl:apply-templates/></dd></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="parameterlist[@kind='param']">
|
||||
<dl><xsl:apply-templates select="parameteritem[1]">
|
||||
<xsl:with-param name="desc" select="'Parameter(s):'"/>
|
||||
</xsl:apply-templates></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="parameterlist[@kind='exception']">
|
||||
<dl><xsl:apply-templates select="parameteritem[1]">
|
||||
<xsl:with-param name="desc" select="'Throws:'"/>
|
||||
<xsl:with-param name="style" select="'plain'"/>
|
||||
</xsl:apply-templates></dl>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="briefdescription">
|
||||
<xsl:apply-templates/>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Synopsis mode -->
|
||||
|
||||
<xsl:template match="compounddef[@kind = 'class']" mode="synopsis">
|
||||
<div id="srcdoc_synopsis">
|
||||
<table id="table_synopsis" border="0" cellpadding="10">
|
||||
<tr><td>
|
||||
<pre>
|
||||
namespace boost {
|
||||
|
||||
template <<xsl:call-template name="template-parameters"/>>
|
||||
class <xsl:value-of select="$container"/>
|
||||
{
|
||||
public:
|
||||
<xsl:call-template name="public-types"/><xsl:text disable-output-escaping="yes">
|
||||
</xsl:text>
|
||||
<xsl:call-template name="constructors"/><xsl:text disable-output-escaping="yes">
|
||||
</xsl:text>
|
||||
<xsl:call-template name="member-functions"/><xsl:text disable-output-escaping="yes">};
|
||||
|
||||
</xsl:text>
|
||||
<xsl:call-template name="standalone-functions"/>
|
||||
} // namespace boost
|
||||
</pre>
|
||||
</td></tr>
|
||||
</table>
|
||||
</div>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="param" mode="synopsis">
|
||||
<xsl:param name="link-prefix" select="''"/>
|
||||
<xsl:value-of select="type"/> <a href="{$link-prefix}#templateparam_{declname}"><xsl:value-of select="declname"/></a><xsl:value-of select="substring(', ', 1 div (count(following-sibling::param) != 0))"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="memberdef[@kind='typedef']" mode="synopsis">
|
||||
<xsl:param name="link-prefix" select="''"/>
|
||||
<xsl:if test="normalize-space(briefdescription) != ''"> typedef <xsl:value-of select="substring('typename ', 1 div (contains(type, '::') and not(contains(type, '>'))))"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="contains(type, 'cb_details::')"><i>implementation-defined</i> </xsl:when>
|
||||
<xsl:otherwise><xsl:apply-templates select="type" mode="synopsis"/> </xsl:otherwise>
|
||||
</xsl:choose>
|
||||
<a href="{$link-prefix}#{@id}"><xsl:value-of select="name"/></a>;<xsl:text disable-output-escaping="yes">
|
||||
</xsl:text>
|
||||
</xsl:if>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="memberdef[@kind='function']" mode="synopsis">
|
||||
<xsl:param name="indent" select="' '"/>
|
||||
<xsl:param name="link-prefix" select="''"/>
|
||||
<xsl:param name="link" select="''"/>
|
||||
<xsl:value-of select="$indent"/>
|
||||
<xsl:value-of select="substring('explicit ', 1 div (@explicit = 'yes'))"/>
|
||||
<xsl:if test="count(templateparamlist) > 0">template <<xsl:for-each select="templateparamlist/param"><xsl:value-of select="type"/> <xsl:value-of select="declname"/><xsl:value-of select="substring(', ', 1 div (count(following-sibling::param) != 0))"/></xsl:for-each>><xsl:text disable-output-escaping="yes">
|
||||
</xsl:text><xsl:value-of select="$indent"/>
|
||||
</xsl:if>
|
||||
<xsl:if test="type != ''"><xsl:apply-templates select="type" mode="synopsis"/> </xsl:if>
|
||||
<a href="{$link-prefix}#{concat(substring(@id, 1 div (string-length($link) = 0)), substring($link, 1 div (string-length($link) > 0)))}">
|
||||
<xsl:value-of select="name"/>
|
||||
</a>(<xsl:for-each select="param">
|
||||
<xsl:apply-templates select="type" mode="synopsis"/> <xsl:value-of select="declname"/>
|
||||
<xsl:value-of select="substring(concat(' = ', defval), 1 div (normalize-space(defval) != ''))"/>
|
||||
<xsl:value-of select="substring(', ', 1 div (count(following-sibling::param) != 0))"/>
|
||||
</xsl:for-each>)<xsl:value-of select="substring(' const', 1 div (@const = 'yes'))"/>;<xsl:text disable-output-escaping="yes">
|
||||
</xsl:text>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="type" mode="synopsis">
|
||||
<xsl:for-each select="text() | ref">
|
||||
<xsl:variable name="item" select="translate(., '&space;', '')"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="contains($item, 'return_value_type') or contains($item, 'param_value_type')">const_reference</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:choose>
|
||||
<xsl:when test="contains($item, ',')"><xsl:value-of select="concat(substring-before($item, ','), ', ', substring-after($item, ','))"/></xsl:when>
|
||||
<xsl:otherwise><xsl:value-of select="$item"/></xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
<xsl:if test="not(contains($item, '<')) and not(contains($item, ',')) and name(.) != 'ref' and position() != last()"> </xsl:if>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<!-- Description mode -->
|
||||
|
||||
<xsl:template match="compounddef[@kind = 'class']" mode="description">
|
||||
<div id="srcdoc_params">
|
||||
<table id="table_template_params" border="1" cellpadding="3">
|
||||
<tr><th>Parameter</th><th>Description</th><th>Default</th></tr>
|
||||
<xsl:call-template name="template-parameters-details"/>
|
||||
</table>
|
||||
</div>
|
||||
<div id="srcdoc_types">
|
||||
<table id="table_public_types" border="1" cellpadding="3">
|
||||
<tr><th>Type</th><th>Description</th></tr>
|
||||
<xsl:call-template name="public-types-details"/>
|
||||
</table>
|
||||
</div>
|
||||
<div id="srcdoc_constructors">
|
||||
<table id="table_constructors" border="1" cellpadding="3">
|
||||
<xsl:call-template name="constructors-details"/>
|
||||
</table>
|
||||
</div>
|
||||
<div id="srcdoc_methods">
|
||||
<table id="table_methods" border="1" cellpadding="3">
|
||||
<xsl:call-template name="member-functions-details"/>
|
||||
</table>
|
||||
</div>
|
||||
<div id="srcdoc_functions">
|
||||
<table id="table_functions" border="1" cellpadding="3">
|
||||
<xsl:call-template name="standalone-functions-details"/>
|
||||
</table>
|
||||
</div>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="parameteritem" mode="description">
|
||||
<tr><td><a id="templateparam_{parameternamelist/parametername}"><code><xsl:value-of select="parameternamelist/parametername"/></code></a></td>
|
||||
<td>
|
||||
<xsl:apply-templates select="parameterdescription"/>
|
||||
<xsl:variable name="type-rqmts" select="concat('Type Requirements ', parameternamelist/parametername)"/>
|
||||
<xsl:if test="../../simplesect[@kind='par']/title = $type-rqmts">
|
||||
<dl><dt><b>Type Requirements:</b></dt>
|
||||
<dd><xsl:apply-templates select="../../simplesect[@kind='par'][title=$type-rqmts]/para"/></dd></dl>
|
||||
</xsl:if>
|
||||
</td>
|
||||
<xsl:variable name="default-value" select="concat('Default ', parameternamelist/parametername)"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="../../simplesect[@kind='par']/title = $default-value">
|
||||
<td><code><xsl:value-of select="../../simplesect[@kind='par'][title=$default-value]/para"/></code></td>
|
||||
</xsl:when>
|
||||
<xsl:otherwise><td><br/></td></xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</tr>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="memberdef[@kind='typedef']" mode="description">
|
||||
<xsl:if test="normalize-space(briefdescription) != ''">
|
||||
<tr><td><a id="{@id}"><code><xsl:value-of select="name"/></code></a></td>
|
||||
<td>
|
||||
<xsl:apply-templates select="briefdescription/child::*"/>
|
||||
<xsl:if test="boolean(detaileddescription/para)">
|
||||
<xsl:apply-templates select="detaileddescription/para/text()|detaileddescription/para/child::*"/>
|
||||
</xsl:if>
|
||||
</td></tr>
|
||||
</xsl:if>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="memberdef[@kind='function']" mode="description">
|
||||
<xsl:param name="link-prefix" select="''"/>
|
||||
<tr><td><a id="{@id}" /><code><b><xsl:value-of select="substring('explicit ', 1 div (@explicit = 'yes'))"/>
|
||||
<xsl:if test="count(templateparamlist) > 0">
|
||||
template <<xsl:for-each select="templateparamlist/param"><xsl:value-of select="type"/> <xsl:value-of select="declname"/><xsl:value-of select="substring(', ', 1 div (count(following-sibling::param) != 0))"/></xsl:for-each>><br />
|
||||
</xsl:if>
|
||||
<xsl:if test="type != ''"><xsl:apply-templates select="type" mode="description"/> </xsl:if>
|
||||
<xsl:value-of select="name"/>(<xsl:for-each select="param">
|
||||
<xsl:apply-templates select="type" mode="description"/> <xsl:value-of select="declname"/>
|
||||
<xsl:value-of select="substring(concat(' = ', defval), 1 div (normalize-space(defval) != ''))"/>
|
||||
<xsl:value-of select="substring(', ', 1 div (count(following-sibling::param) != 0))"/>
|
||||
</xsl:for-each>)<xsl:value-of select="substring(' const', 1 div (@const = 'yes'))"/>;</b></code><br /><br />
|
||||
<xsl:apply-templates select="briefdescription"/>
|
||||
<xsl:if test="normalize-space(detaileddescription) = ''">
|
||||
<br /><br />
|
||||
</xsl:if>
|
||||
<p><xsl:apply-templates select="detaileddescription"/></p>
|
||||
</td></tr>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template match="type" mode="description">
|
||||
<xsl:for-each select="text() | ref">
|
||||
<xsl:variable name="item" select="translate(., '&space;', '')"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="$item = 'return_value_type' or $item = 'param_value_type'">
|
||||
<xsl:variable name="const-reference" select="$class[@kind = 'class']/sectiondef[@kind='public-type']/memberdef[@kind='typedef' and name='const_reference']"/>
|
||||
<xsl:choose>
|
||||
<xsl:when test="boolean($const-reference/reimplements)">
|
||||
<a href="{$link-prefix}#{$const-reference/reimplements/@refid}">const_reference</a>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<a href="{$link-prefix}#{$const-reference/@id}">const_reference</a>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:when>
|
||||
<xsl:when test="contains($item, 'circular_buffer')"><xsl:value-of select="$item"/></xsl:when>
|
||||
<xsl:when test="@refid">
|
||||
<xsl:element name="a">
|
||||
<xsl:attribute name="href"><xsl:call-template name="reference"/></xsl:attribute>
|
||||
<xsl:value-of select="$item"/>
|
||||
</xsl:element>
|
||||
</xsl:when>
|
||||
<xsl:otherwise><xsl:value-of select="$item"/></xsl:otherwise>
|
||||
</xsl:choose>
|
||||
<xsl:if test="name(.) != 'ref' and position() != last()"> </xsl:if>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@@ -1,18 +0,0 @@
|
||||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!--
|
||||
Helper XSL transformation which converts HTML into XHTML.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:import href="copy.xslt"/>
|
||||
|
||||
<xsl:output method="xml" version="1.0" encoding="iso-8859-1" indent="yes" media-type="text/html"/>
|
||||
|
||||
</xsl:stylesheet>
|
||||
File diff suppressed because it is too large
Load Diff
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
@@ -1,106 +0,0 @@
|
||||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!--
|
||||
XSL transformation from the XML files generated by Doxygen into XHTML source
|
||||
code documentation of the circular_buffer_space_optimized.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:import href="doxygen2html.xslt"/>
|
||||
|
||||
<xsl:output method="xml" version="1.0" encoding="iso-8859-1" indent="yes" media-type="text/xml"/>
|
||||
|
||||
<xsl:variable name="link-prefix" select="'circular_buffer.html'"/>
|
||||
<xsl:variable name="circular_buffer-ref" select="//compound[name='boost::circular_buffer' and @kind='class']/@refid"/>
|
||||
<xsl:variable name="circular_buffer-file" select="concat($xmldir, '/', $circular_buffer-ref, '.xml')"/>
|
||||
<xsl:variable name="circular_buffer-reimplemented" select="document($circular_buffer-file)/doxygen/compounddef[@id = $circular_buffer-ref and @kind = 'class']//reimplementedby"/>
|
||||
<xsl:variable name="standalone-functions" select="document(concat($xmldir, '/namespaceboost.xml'))/doxygen/compounddef/sectiondef[@kind='func']"/>
|
||||
|
||||
<xsl:template name="reference">
|
||||
<xsl:variable name="refid" select="$circular_buffer-reimplemented[@refid=current()/@refid and text()!='capacity_type']/../@id"/>
|
||||
<xsl:value-of select="concat(substring(concat($link-prefix, '#', $refid), 1 div (string-length($refid) > 0)), substring(concat('#', @refid), 1 div (string-length($refid) = 0)))"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="template-parameters">
|
||||
<xsl:apply-templates select="templateparamlist/param" mode="synopsis">
|
||||
<xsl:with-param name="link-prefix" select="$link-prefix"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="public-types">
|
||||
<xsl:for-each select="sectiondef[@kind='public-type']/memberdef">
|
||||
<xsl:if test="string-length(normalize-space(briefdescription)) > 0">
|
||||
<xsl:choose>
|
||||
<xsl:when test="document($circular_buffer-file)/doxygen/compounddef[@id = $circular_buffer-ref and @kind = 'class']/sectiondef[@kind='public-type']/memberdef[name=current()/name]/briefdescription = briefdescription">
|
||||
<xsl:apply-templates select="document($circular_buffer-file)/doxygen/compounddef[@id = $circular_buffer-ref and @kind = 'class']/sectiondef[@kind='public-type']/memberdef[name=current()/name]" mode="synopsis">
|
||||
<xsl:with-param name="link-prefix" select="$link-prefix"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:when>
|
||||
<xsl:otherwise>
|
||||
<xsl:apply-templates select="." mode="synopsis"/>
|
||||
</xsl:otherwise>
|
||||
</xsl:choose>
|
||||
</xsl:if>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="constructors">
|
||||
<xsl:for-each select="sectiondef[@kind='public-func']/memberdef[type = '']">
|
||||
<xsl:variable name="briefdescription" select="normalize-space(briefdescription)"/>
|
||||
<xsl:if test="string-length($briefdescription) > 0">
|
||||
<xsl:apply-templates select="." mode="synopsis"/>
|
||||
</xsl:if>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="member-functions">
|
||||
<xsl:variable name="current" select="sectiondef[@kind='public-func']/memberdef[type != '']"/>
|
||||
<xsl:for-each select="document($circular_buffer-file)/doxygen/compounddef[@id = $circular_buffer-ref and @kind = 'class']/sectiondef[@kind='public-func']/memberdef[type != '']">
|
||||
<xsl:if test="count($current[name=current()/name and string-length(normalize-space(briefdescription)) > 0]) = 0">
|
||||
<xsl:apply-templates select="." mode="synopsis">
|
||||
<xsl:with-param name="link-prefix" select="$link-prefix"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:if>
|
||||
</xsl:for-each>
|
||||
<xsl:for-each select="$current[string-length(normalize-space(briefdescription)) > 0]">
|
||||
<xsl:apply-templates select="." mode="synopsis"/>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="standalone-functions">
|
||||
<xsl:for-each select="$standalone-functions/memberdef[contains(argsstring, 'circular_buffer_space_optimized<')]">
|
||||
<xsl:apply-templates select="." mode="synopsis">
|
||||
<xsl:with-param name="indent" select="''"/>
|
||||
<xsl:with-param name="link-prefix" select="$link-prefix"/>
|
||||
<xsl:with-param name="link" select="$standalone-functions/memberdef[contains(argsstring, 'circular_buffer<') and name=current()/name]/@id"/>
|
||||
</xsl:apply-templates>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="template-parameters-details"/>
|
||||
|
||||
<xsl:template name="public-types-details">
|
||||
<xsl:apply-templates select="sectiondef[@kind='public-type']/memberdef[not(contains(type, 'circular_buffer<'))]" mode="description"/>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="constructors-details">
|
||||
<xsl:for-each select="sectiondef[@kind='public-func']/memberdef[type = '' and string-length(normalize-space(briefdescription)) > 0]">
|
||||
<xsl:apply-templates select="." mode="description"/>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="member-functions-details">
|
||||
<xsl:for-each select="sectiondef[@kind='public-func']/memberdef[type != '' and string-length(normalize-space(briefdescription)) > 0]">
|
||||
<xsl:apply-templates select="." mode="description"/>
|
||||
</xsl:for-each>
|
||||
</xsl:template>
|
||||
|
||||
<xsl:template name="standalone-functions-details"/>
|
||||
|
||||
</xsl:stylesheet>
|
||||
@@ -1,54 +0,0 @@
|
||||
#!/bin/sh
|
||||
################################################################################
|
||||
# Shell script which updates the Circular Buffer library documentation with #
|
||||
# the latest source code documentation (which is in the source files). #
|
||||
# #
|
||||
# Copyright (c) 2007 Jan Gaspar #
|
||||
# #
|
||||
# Use, modification, and distribution is subject to the Boost Software #
|
||||
# License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at #
|
||||
# http://www.boost.org/LICENSE_1_0.txt) #
|
||||
################################################################################
|
||||
|
||||
CONTAINER=$1
|
||||
DOCFILE="$CONTAINER.html"
|
||||
XSLT="$CONTAINER.xslt"
|
||||
XHTML="$CONTAINER.xhtml"
|
||||
SPECIALIZATION=${CONTAINER#circular_buffer_}
|
||||
|
||||
if [ ${#SPECIALIZATION} -gt 0 ]; then
|
||||
DOCFILE=${DOCFILE#circular_buffer_}
|
||||
XSLT=${XSLT#circular_buffer_}
|
||||
XHTML=${XHTML#circular_buffer_}
|
||||
fi
|
||||
|
||||
if [ -f $DOCFILE ]; then
|
||||
|
||||
echo Starting Doxygen ...
|
||||
doxygen
|
||||
|
||||
echo Converting Doxygen generated source code documentation into XHTML ...
|
||||
xsltproc --stringparam container $CONTAINER --stringparam xmldir srcdoc -o srcdoc/srcdoc.xhtml $XSLT srcdoc/index.xml
|
||||
|
||||
echo Preprocessing $DOCFILE ...
|
||||
sed 's/<a\s*id="[^"]*"/<a /g' $DOCFILE | sed 's/<a\s*\(name="[^"]*"\)\s*\(id="[^"]*"\)/<a \1/g' > srcdoc/$DOCFILE
|
||||
|
||||
echo Converting preprocessed $DOCFILE into XHTML ...
|
||||
xsltproc --html -o srcdoc/$XHTML html2xhtml.xslt srcdoc/$DOCFILE
|
||||
|
||||
echo Generating $DOCFILE with updated source code documentation ...
|
||||
xsltproc --stringparam srcdoc srcdoc/srcdoc.xhtml -o $DOCFILE update_srcdoc.xslt srcdoc/$XHTML
|
||||
|
||||
echo Correcting and pretty-printing $DOCFILE with HTML Tidy ...
|
||||
tidy -ashtml -config Tidy.conf $DOCFILE
|
||||
|
||||
echo Removing temporary directory ...
|
||||
rm -rf srcdoc
|
||||
|
||||
echo Done.
|
||||
|
||||
else
|
||||
|
||||
echo Usage: update_srcdoc.sh container
|
||||
|
||||
fi
|
||||
@@ -1,25 +0,0 @@
|
||||
<?xml version='1.0' encoding='iso-8859-1'?>
|
||||
<!--
|
||||
Helper XSL transformation updating source code documentation sections
|
||||
in the specified HTML file.
|
||||
|
||||
Copyright (c) 2007 Jan Gaspar
|
||||
|
||||
Use, modification, and distribution is subject to the Boost Software
|
||||
License, Version 1.0. (See accompanying file LICENSE_1_0.txt or copy at
|
||||
http://www.boost.org/LICENSE_1_0.txt)
|
||||
-->
|
||||
|
||||
<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" version="1.0">
|
||||
|
||||
<xsl:import href="copy.xslt"/>
|
||||
|
||||
<xsl:output method="html" version="1.0" encoding="iso-8859-1" indent="yes" omit-xml-declaration="yes" media-type="text/html"/>
|
||||
|
||||
<xsl:param name="srcdoc"/>
|
||||
|
||||
<xsl:template match="div[contains(@id, 'srcdoc')]">
|
||||
<xsl:copy-of select="document($srcdoc)//body/div[@id=current()/@id]"/>
|
||||
</xsl:template>
|
||||
|
||||
</xsl:stylesheet>
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 1.4 KiB |
Reference in New Issue
Block a user