chiark / gitweb /
doxygen: don't include function parameter names in search results.
authorVladimír Vondruš <mosra@centrum.cz>
Sun, 28 Jan 2018 21:45:02 +0000 (22:45 +0100)
committerVladimír Vondruš <mosra@centrum.cz>
Sat, 3 Feb 2018 09:51:55 +0000 (10:51 +0100)
Too damn long.

doc/doxygen.rst
doxygen/dox2html5.py
doxygen/templates/details-func.html
doxygen/templates/entry-func.html
doxygen/test/search/Dir/File.h
doxygen/test/test_search.py

index 7f90b90ab2207527c7ae6cd718146fcf97bbaeb3..5f7dbff1b68a477a9af15a6501911bbe1384721e 100644 (file)
@@ -1254,7 +1254,9 @@ Each item has the following properties:
 Property                    Description
 =========================== ===================================================
 :py:`param.name`            Parameter name (if not anonymous)
-:py:`param.type`            Parameter type, together with name and array
+:py:`param.type`            Parameter type, together with array specification
+                            [6]_
+:py:`param.type_name`       Parameter type, together with name and array
                             specification [6]_
 :py:`param.default`         Default parameter value, if any [6]_
 :py:`param.description`     Optional parameter description. If set,
index 64ef448a746b17d89937a0021cba44058cbe1d63..7fde75d70fb2448592982ffef32247173d19da6f 100755 (executable)
@@ -1272,13 +1272,16 @@ def parse_func(state: State, element: ET.Element):
         if array is not None:
             if name is not None:
                 if param.type.endswith(')'):
-                    param.type = param.type[:-1] + name.text + ')' + array.text
+                    param.type_name = param.type[:-1] + name.text + ')' + array.text
                 else:
-                    param.type = param.type + ' ' + name.text + array.text
+                    param.type_name = param.type + ' ' + name.text + array.text
             else:
-                param.type += array.text
+                param.type_name = param.type + array.text
+            param.type += array.text
         elif name is not None:
-            param.type += ' ' + name.text
+            param.type_name = param.type + ' ' + name.text
+        else:
+            param.type_name = param.type
 
         param.default = parse_type(state, p.find('defval'))
         if param.name in params:
index 58b63965cae97b7efdf5cb993574ec7909853c47..5543fc1cdf9e01b8349a119472b4be5d06f0e5e2 100644 (file)
@@ -13,7 +13,7 @@
               </div>
               {% endif %}
               {% set j = joiner(',\n              ') %}
-              <span class="m-dox-wrap-bumper">{{ func.prefix }}{{ func.type }} {{ prefix }}</span><span class="m-dox-wrap"><span class="m-dox-wrap-bumper"><a href="#{{ func.id }}" class="m-dox-self">{{ func.name }}</a>(</span><span class="m-dox-wrap">{% for param in func.params %}{{ j() }}{{ param.type }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.is_explicit %} <span class="m-label m-info">explicit</span> {% endif %}{% if func.is_pure_virtual %} <span class="m-label m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-warning">virtual</span>{% endif %}{% if func.is_protected %} <span class="m-label m-warning">protected</span>{% elif func.is_private %} <span class="m-label m-danger">private</span>{% endif %}{% if func.is_defaulted %} <span class="m-label m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-danger">deleted</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-primary">constexpr</span>{% endif %}{% if func.is_noexcept %} <span class="m-label m-success">noexcept</span>{% endif %}</span></span>
+              <span class="m-dox-wrap-bumper">{{ func.prefix }}{{ func.type }} {{ prefix }}</span><span class="m-dox-wrap"><span class="m-dox-wrap-bumper"><a href="#{{ func.id }}" class="m-dox-self">{{ func.name }}</a>(</span><span class="m-dox-wrap">{% for param in func.params %}{{ j() }}{{ param.type_name }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.is_explicit %} <span class="m-label m-info">explicit</span> {% endif %}{% if func.is_pure_virtual %} <span class="m-label m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-warning">virtual</span>{% endif %}{% if func.is_protected %} <span class="m-label m-warning">protected</span>{% elif func.is_private %} <span class="m-label m-danger">private</span>{% endif %}{% if func.is_defaulted %} <span class="m-label m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-danger">deleted</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-primary">constexpr</span>{% endif %}{% if func.is_noexcept %} <span class="m-label m-success">noexcept</span>{% endif %}</span></span>
             </h3>
             {% if func.brief %}
             <p>{{ func.brief }}</p>
index a7e091231b8ae0b03ad05ad7e5af6841aabb0f54..39c6b351ea68f306e119acb01f841861594cb45f 100644 (file)
@@ -4,6 +4,6 @@
               <div class="m-dox-template">template&lt;{% for t in func.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}&gt;</div>
               {% endif %}
               {% set j = joiner(',\n              ') %}
-              <span class="m-dox-wrap-bumper">{{ func.prefix }}{% if func.type == 'void' %}void {% elif func.type %}auto {% endif %}<a href="#{{ func.id }}" {% if func.has_details %}class="m-dox"{% else %}class="m-dox-self" name="{{ func.id }}"{% endif %}>{{ func.name }}</a>(</span><span class="m-dox-wrap">{% for param in func.params %}{{ j() }}{{ param.type }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.type and func.type != 'void' %} -&gt; {{ func.type }}{% endif %}{% if not func.type or mark_nonpublic %}{% if func.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% elif func.is_private %} <span class="m-label m-flat m-danger">private</span>{% endif %}{% endif %}{% if func.is_defaulted %} <span class="m-label m-flat m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-flat m-danger">deleted</span>{% endif %}{% if func.is_explicit %} <span class="m-label m-flat m-info">explicit</span> {% endif %}{% if func.is_pure_virtual %} <span class="m-label m-flat m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-flat m-warning">virtual</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-flat m-primary">constexpr</span>{% endif %}{% if func.is_noexcept %} <span class="m-label m-flat m-success">noexcept</span>{% endif %}</span>
+              <span class="m-dox-wrap-bumper">{{ func.prefix }}{% if func.type == 'void' %}void {% elif func.type %}auto {% endif %}<a href="#{{ func.id }}" {% if func.has_details %}class="m-dox"{% else %}class="m-dox-self" name="{{ func.id }}"{% endif %}>{{ func.name }}</a>(</span><span class="m-dox-wrap">{% for param in func.params %}{{ j() }}{{ param.type_name }}{% if param.default %} = {{ param.default }}{% endif %}{% endfor %}){{ func.suffix }}{% if func.type and func.type != 'void' %} -&gt; {{ func.type }}{% endif %}{% if not func.type or mark_nonpublic %}{% if func.is_protected %} <span class="m-label m-flat m-warning">protected</span>{% elif func.is_private %} <span class="m-label m-flat m-danger">private</span>{% endif %}{% endif %}{% if func.is_defaulted %} <span class="m-label m-flat m-info">defaulted</span>{% endif %}{% if func.is_deleted %} <span class="m-label m-flat m-danger">deleted</span>{% endif %}{% if func.is_explicit %} <span class="m-label m-flat m-info">explicit</span> {% endif %}{% if func.is_pure_virtual %} <span class="m-label m-flat m-warning">pure virtual</span>{% elif func.is_virtual %} <span class="m-label m-flat m-warning">virtual</span>{% endif %}{% if func.is_constexpr %} <span class="m-label m-flat m-primary">constexpr</span>{% endif %}{% if func.is_noexcept %} <span class="m-label m-flat m-success">noexcept</span>{% endif %}</span>
             </dt>
             <dd>{{ func.brief }}</dd>
index 72819d5ba76f4091d914467cdcd211048b31a2da..459d447e5dee29588688439fa03e53132ef0a6f7 100644 (file)
@@ -20,7 +20,7 @@ class Class {
         void foo() &&; /**< @overload */
 
         /** @brief Function with arguments */
-        void foo(const Enum&, Typedef);
+        void foo(const Enum& first, Typedef second);
 };
 
 /** @brief A variable */
index 1e1251a47f9134edc625f9969428a0704470fe9e..82252aaee15036e4bc75f628e8665f828f7d94bf 100755 (executable)
@@ -339,7 +339,7 @@ macro [14]
 6: Namespace::Class::foo() [0] -> classNamespace_1_1Class.html#aaeba4096356215868370d6ea476bf5d9
 7: Namespace::Class::foo() const [1, suffix_length=6] -> classNamespace_1_1Class.html#ac03c5b93907dda16763eabd26b25500a
 8: Namespace::Class::foo() && [1, suffix_length=3] -> classNamespace_1_1Class.html#ac9e7e80d06281e30cfcc13171d117ade
-9: Namespace::Class::foo(const Enum&, Typedef) [1, suffix_length=20] -> classNamespace_1_1Class.html#abd560769b0863ca5d64905e8e0fc231b
+9: Namespace::Class::foo(const Enum&, Typedef) [1, suffix_length=20] -> classNamespace_1_1Class.html#aba8d57a830d4d79f86d58d92298677fa
 10: Namespace::Enum::Value [0] -> namespaceNamespace.html#add172b93283b1ab7612c3ca6cc5dcfeaa689202409e48743b914713f96d93947c
 11: Namespace::Enum [0] -> namespaceNamespace.html#add172b93283b1ab7612c3ca6cc5dcfea
 12: Namespace::Typedef [0] -> namespaceNamespace.html#abe2a245304bc2234927ef33175646e08