|
|
Boost-Commit : |
Subject: [Boost-commit] svn:boost r83732 - in trunk/libs/geometry/doc: html index index/generated src/docutils/tools/doxygen_xml2qbk
From: adam.wulkiewicz_at_[hidden]
Date: 2013-04-02 20:26:45
Author: awulkiew
Date: 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
New Revision: 83732
URL: http://svn.boost.org/trac/boost/changeset/83732
Log:
doxygen_xml2qbk: functions without brief description removed from alternative output - consistent with other members. Fixed synopsis for functions without named parameters. Index's Doxyfile modified. Documentation updated.
Text files modified:
trunk/libs/geometry/doc/html/index.html | 2 +-
trunk/libs/geometry/doc/index/Doxyfile | 14 ++++++--------
trunk/libs/geometry/doc/index/generated/equal_to.qbk | 33 +++++++++++++++++++++++++++++++++
trunk/libs/geometry/doc/index/generated/indexable.qbk | 32 ++++++++++++++++++++++++++++++++
trunk/libs/geometry/doc/index/generated/rtree_rstar.qbk | 2 +-
trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp | 12 ++++++++++--
6 files changed, 83 insertions(+), 12 deletions(-)
Modified: trunk/libs/geometry/doc/html/index.html
==============================================================================
--- trunk/libs/geometry/doc/html/index.html (original)
+++ trunk/libs/geometry/doc/html/index.html 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -102,7 +102,7 @@
</ul></div>
</div>
<table xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" width="100%"><tr>
-<td align="left"><p><small>Last revised: April 02, 2013 at 22:44:07 GMT</small></p></td>
+<td align="left"><p><small>Last revised: April 03, 2013 at 00:19:36 GMT</small></p></td>
<td align="right"><div class="copyright-footer"></div></td>
</tr></table>
<hr>
Modified: trunk/libs/geometry/doc/index/Doxyfile
==============================================================================
--- trunk/libs/geometry/doc/index/Doxyfile (original)
+++ trunk/libs/geometry/doc/index/Doxyfile 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -35,8 +35,7 @@
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
TAB_SIZE = 8
-ALIASES = bgi_exception{1}="\xmlonly <qbk> [heading Exception-safety] \1 </qbk> \endxmlonly \htmlonly <dl class=\"section return\"><dt>Exception-safety</dt><dd>\1</dd></dl> \endhtmlonly \latexonly \begin{DoxyReturn}{Exception-safety} \1 \end{DoxyReturn} \endlatexonly" \
- bgi_throws{1}="\xmlonly <qbk> [heading Throws] \1 </qbk> \endxmlonly \htmlonly <dl class=\"section return\"><dt>Throws</dt><dd>\1</dd></dl> \endhtmlonly \latexonly \begin{DoxyReturn}{Throws} \1 \end{DoxyReturn} \endlatexonly"
+ALIASES =
TCL_SUBST =
OPTIMIZE_OUTPUT_FOR_C = NO
OPTIMIZE_OUTPUT_JAVA = NO
@@ -44,7 +43,7 @@
OPTIMIZE_OUTPUT_VHDL = NO
EXTENSION_MAPPING =
MARKDOWN_SUPPORT = YES
-BUILTIN_STL_SUPPORT = NO
+BUILTIN_STL_SUPPORT = YES
CPP_CLI_SUPPORT = NO
SIP_SUPPORT = NO
IDL_PROPERTY_SUPPORT = YES
@@ -65,8 +64,8 @@
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
EXTRACT_ANON_NSPACES = NO
-HIDE_UNDOC_MEMBERS = NO
-HIDE_UNDOC_CLASSES = NO
+HIDE_UNDOC_MEMBERS = YES
+HIDE_UNDOC_CLASSES = YES
HIDE_FRIEND_COMPOUNDS = NO
HIDE_IN_BODY_DOCS = NO
INTERNAL_DOCS = NO
@@ -96,7 +95,7 @@
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
-QUIET = NO
+QUIET = YES
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
@@ -107,8 +106,7 @@
# configuration options related to the input files
#---------------------------------------------------------------------------
INPUT = ../../../../boost/geometry/index/ \
- ../../../../boost/geometry/index/adaptors \
- ../../../../boost/geometry/index/translator
+ ../../../../boost/geometry/index/adaptors
INPUT_ENCODING = UTF-8
FILE_PATTERNS = *.c \
*.cc \
Modified: trunk/libs/geometry/doc/index/generated/equal_to.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/generated/equal_to.qbk (original)
+++ trunk/libs/geometry/doc/index/generated/equal_to.qbk 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -26,5 +26,38 @@
[[`Value`][The type of objects which are compared by this function object. ]]
]
+[heading Typedef(s)]
+[table
+[[Type] [Description]]
+[[[#structboost_1_1geometry_1_1index_1_1equal__to_1a96a4ec5188f34ad90ea154308a93ebae] `result_type`][The type of result returned by function object. ]]
+]
+
+[heading Member(s)]
+[table
+[[Modifier][Function][Description]]
+[[ `const`][[link structboost_1_1geometry_1_1index_1_1equal__to_1adb497915885d69df9aff938d16922ff3 `operator()(Value const &, Value const &)`]][Compare values. If Value is a Geometry geometry::equals() function is used. ]]
+]
+
+[#structboost_1_1geometry_1_1index_1_1equal__to_1adb497915885d69df9aff938d16922ff3]
+[section operator()(Value const &, Value const &)]
+Compare values. If Value is a Geometry geometry::equals() function is used.
+
+[heading Synopsis]
+[pre
+
+`bool` `operator()``(``Value const &` `l``,` `Value const &` `r``)`
+]
+
+[heading Modifier(s)]
+``const ``[heading Parameter(s)]
+[table
+[[Type][Name][Description]]
+[[`Value const &`][ `l` ][First value. ]]
+[[`Value const &`][ `r` ][Second value. ]]
+]
+[heading Returns]
+true if values are equal.
+[endsect]
+
[endsect]
Modified: trunk/libs/geometry/doc/index/generated/indexable.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/generated/indexable.qbk (original)
+++ trunk/libs/geometry/doc/index/generated/indexable.qbk 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -26,5 +26,37 @@
[[`Value`][The Value type which may be translated directly to the Indexable. ]]
]
+[heading Typedef(s)]
+[table
+[[Type] [Description]]
+[[[#structboost_1_1geometry_1_1index_1_1indexable_1a1b2b7a94fb62e59fd1f0587fa0aef5ef] `result_type`][The type of result returned by function object. ]]
+]
+
+[heading Member(s)]
+[table
+[[Modifier][Function][Description]]
+[[ `const`][[link structboost_1_1geometry_1_1index_1_1indexable_1afa5f2cdc3390a6f1f394890e479df794 `operator()(Value const &)`]][Return indexable extracted from the value. ]]
+]
+
+[#structboost_1_1geometry_1_1index_1_1indexable_1afa5f2cdc3390a6f1f394890e479df794]
+[section operator()(Value const &)]
+Return indexable extracted from the value.
+
+[heading Synopsis]
+[pre
+
+[^[link structboost_1_1geometry_1_1index_1_1indexable_1a1b2b7a94fb62e59fd1f0587fa0aef5ef result_type]] `operator()``(``Value const &` `v``)`
+]
+
+[heading Modifier(s)]
+``const ``[heading Parameter(s)]
+[table
+[[Type][Name][Description]]
+[[`Value const &`][ `v` ][The value. ]]
+]
+[heading Returns]
+The indexable.
+[endsect]
+
[endsect]
Modified: trunk/libs/geometry/doc/index/generated/rtree_rstar.qbk
==============================================================================
--- trunk/libs/geometry/doc/index/generated/rtree_rstar.qbk (original)
+++ trunk/libs/geometry/doc/index/generated/rtree_rstar.qbk 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -13,7 +13,7 @@
`template<``size_t MaxElements``,`
`size_t MinElements``,`
`size_t OverlapCostThreshold` = `0``,`
- `size_t ReinsertedElements` = [^[link structboost_1_1geometry_1_1index_1_1detail_1_1default__rstar__reinserted__elements__s detail::default_rstar_reinserted_elements_s]]`<MaxElements>::value``>`
+ `size_t ReinsertedElements` = `detail::default_rstar_reinserted_elements_s<MaxElements>::value``>`
`struct rstar`
`{`
` // ...`
Modified: trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp
==============================================================================
--- trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp (original)
+++ trunk/libs/geometry/doc/src/docutils/tools/doxygen_xml2qbk/quickbook_output.hpp 2013-04-02 20:26:43 EDT (Tue, 02 Apr 2013)
@@ -709,7 +709,7 @@
bool show_modifiers = false;
BOOST_FOREACH(function const& f, functions)
{
- if ( (display_all || f.type == type) && (f.is_const || f.is_static) )
+ if ( (display_all || f.type == type) && (f.is_const || f.is_static) && !f.brief_description.empty() )
show_modifiers = true;
}
@@ -725,6 +725,9 @@
{
function const& f = functions[i];
+ if ( f.brief_description.empty() )
+ continue;
+
if (display_all || f.type == type)
{
out << "[";
@@ -912,7 +915,8 @@
inline_str_with_links(p.fulltype, out);
out << " ";
}
- out << "`" << p.name << "`";
+ if ( !p.name.empty() )
+ out << "`" << p.name << "`";
if ( !p.default_value.empty() )
{
out << " = ";
@@ -1039,6 +1043,10 @@
for ( size_t i = 0 ; i < functions.size() ; ++i )
{
function const& f = functions[i];
+
+ if ( f.brief_description.empty() )
+ continue;
+
if ( display_all || f.type == type )
{
// Section
Boost-Commit list run by bdawes at acm.org, david.abrahams at rcn.com, gregod at cs.rpi.edu, cpdaniel at pacbell.net, john at johnmaddock.co.uk