From bce7fe3ee1247c6929495ad4c900f81f762fca45 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Thu, 18 Jul 2019 16:27:18 +0200 Subject: [PATCH] documentation/doxygen: move entry ID to the
element. And it's no longer the deprecated name attribute, but rather an id. --- .../templates/doxygen/entry-define.html | 4 +- .../templates/doxygen/entry-enum.html | 4 +- .../templates/doxygen/entry-func.html | 4 +- .../templates/doxygen/entry-typedef.html | 4 +- .../templates/doxygen/entry-var.html | 4 +- .../compound_includes/classClass.html | 4 +- .../compound_includes/namespaceContained.html | 32 ++--- .../classClass.html | 4 +- .../group__group.html | 20 ++-- .../namespaceContained.html | 32 ++--- .../namespaceSpread.html | 32 ++--- .../compound_listing/File_8h.html | 8 +- ...lassRoot_1_1Directory_1_1Sub_1_1Class.html | 112 +++++++++--------- .../compound_modules/group__group.html | 4 +- .../compound_modules/group__group2.html | 4 +- .../File_8h.html | 16 +-- .../namespaceNamespace.html | 16 +-- .../File_8h.html | 4 +- .../compound_warnings/namespaceMagnum.html | 4 +- .../File_8h.html | 4 +- .../contents_unexpected_sections/File_8h.html | 16 +-- .../test_doxygen/cpp_enum_class/File_8h.html | 4 +- .../test_doxygen/cpp_friends/classClass.html | 8 +- .../cpp_function_attributes/classBase.html | 8 +- .../cpp_function_attributes/classDerived.html | 4 +- .../structFoo.html | 16 +-- .../cpp_variable_template/structBar.html | 4 +- .../cpp_variable_template/structFoo.html | 4 +- .../test_doxygen/undocumented/File_8h.html | 60 +++++----- .../structNamespace_1_1ClassInANamespace.html | 20 ++-- 30 files changed, 230 insertions(+), 230 deletions(-) diff --git a/documentation/templates/doxygen/entry-define.html b/documentation/templates/doxygen/entry-define.html index 415fab93..c6a03347 100644 --- a/documentation/templates/doxygen/entry-define.html +++ b/documentation/templates/doxygen/entry-define.html @@ -1,5 +1,5 @@ -
+ {% set j = joiner(',\n ') %} - #define {{ define.name }}{% if define.params != None %}({% for param in define.params %}{{ j() }}{{ param[0] }}{% endfor %}){% endif %}{% if define.is_deprecated %} deprecated{% endif %} + #define {{ define.name }}{% if define.params != None %}({% for param in define.params %}{{ j() }}{{ param[0] }}{% endfor %}){% endif %}{% if define.is_deprecated %} deprecated{% endif %}
{{ define.brief }}
diff --git a/documentation/templates/doxygen/entry-enum.html b/documentation/templates/doxygen/entry-enum.html index fa14ba69..dcfc5680 100644 --- a/documentation/templates/doxygen/entry-enum.html +++ b/documentation/templates/doxygen/entry-enum.html @@ -1,5 +1,5 @@ -
+ {% set j = joiner(',\n ') %} - enum {% if enum.is_strong %}class {% endif %}{{ enum.name }}{% if enum.type %}: {{ enum.type }}{% endif %} { {% for value in enum.values %}{{ j() }}{{ value.name }}{% if value.initializer %} {{ value.initializer }}{% endif %}{% if value.is_deprecated %} deprecated{% endif %}{% endfor %} }{% if enum.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and enum.is_protected %} protected{% endif %} + enum {% if enum.is_strong %}class {% endif %}{{ enum.name }}{% if enum.type %}: {{ enum.type }}{% endif %} { {% for value in enum.values %}{{ j() }}{{ value.name }}{% if value.initializer %} {{ value.initializer }}{% endif %}{% if value.is_deprecated %} deprecated{% endif %}{% endfor %} }{% if enum.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and enum.is_protected %} protected{% endif %}
{{ enum.brief }}
diff --git a/documentation/templates/doxygen/entry-func.html b/documentation/templates/doxygen/entry-func.html index 78c4e58e..80bd6678 100644 --- a/documentation/templates/doxygen/entry-func.html +++ b/documentation/templates/doxygen/entry-func.html @@ -1,9 +1,9 @@ -
+ {% if func.templates != None %} {% set j = joiner(', ') %}
template<{% for t in func.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif %}{% endfor %}>
{% endif %} {% set j = joiner(',\n ') %} - {{ func.prefix }}{% if func.type == 'void' %}void {% elif func.type %}auto {% endif %}{{ func.name }}({% 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' %} -> {{ func.type }}{% endif %}{% if func.is_deprecated %} deprecated{% endif %}{% if not func.type or mark_nonpublic %}{% if func.is_protected %} protected{% if func.is_slot %} slot{% endif %}{% elif func.is_private %} private{% if func.is_slot %} slot{% endif %}{% elif func.is_signal %} signal{% elif func.is_slot %} public slot{% endif %}{% endif %}{% if func.is_defaulted %} defaulted{% endif %}{% if func.is_deleted %} deleted{% endif %}{% if func.is_explicit %} explicit {% endif %}{% if func.is_final %} final{% elif func.is_override %} override{% elif func.is_pure_virtual %} pure virtual{% elif func.is_virtual %} virtual{% endif %}{% if func.is_constexpr %} constexpr{% endif %}{% if func.is_conditional_noexcept %} noexcept(…){% elif func.is_noexcept %} noexcept{% endif %} + {{ func.prefix }}{% if func.type == 'void' %}void {% elif func.type %}auto {% endif %}{{ func.name }}({% 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' %} -> {{ func.type }}{% endif %}{% if func.is_deprecated %} deprecated{% endif %}{% if not func.type or mark_nonpublic %}{% if func.is_protected %} protected{% if func.is_slot %} slot{% endif %}{% elif func.is_private %} private{% if func.is_slot %} slot{% endif %}{% elif func.is_signal %} signal{% elif func.is_slot %} public slot{% endif %}{% endif %}{% if func.is_defaulted %} defaulted{% endif %}{% if func.is_deleted %} deleted{% endif %}{% if func.is_explicit %} explicit {% endif %}{% if func.is_final %} final{% elif func.is_override %} override{% elif func.is_pure_virtual %} pure virtual{% elif func.is_virtual %} virtual{% endif %}{% if func.is_constexpr %} constexpr{% endif %}{% if func.is_conditional_noexcept %} noexcept(…){% elif func.is_noexcept %} noexcept{% endif %}
{{ func.brief }}
diff --git a/documentation/templates/doxygen/entry-typedef.html b/documentation/templates/doxygen/entry-typedef.html index c8783167..e2395d0f 100644 --- a/documentation/templates/doxygen/entry-typedef.html +++ b/documentation/templates/doxygen/entry-typedef.html @@ -1,9 +1,9 @@ -
+ {% if typedef.templates != None %} {% set j = joiner(', ') %}
template<{% for t in typedef.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}>
{% endif %} - using {{ typedef.name }} = {{ typedef.type }}{{ typedef.args }}{% if typedef.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and typedef.is_protected %} protected{% endif %} + using {{ typedef.name }} = {{ typedef.type }}{{ typedef.args }}{% if typedef.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and typedef.is_protected %} protected{% endif %} {# This empty line needs to be there otherwise it's eaten #}
diff --git a/documentation/templates/doxygen/entry-var.html b/documentation/templates/doxygen/entry-var.html index cb979ea0..a1740271 100644 --- a/documentation/templates/doxygen/entry-var.html +++ b/documentation/templates/doxygen/entry-var.html @@ -1,9 +1,9 @@ -
+ {% if var.templates != None %} {% set j = joiner(', ') %}
template<{% for t in var.templates %}{{ j() }}{{ t.type }}{% if t.name %} {{ t.name }}{% endif %}{% if t.default %} = {{ t.default }}{% endif%}{% endfor %}>
{% endif %} - {%+ if var.is_static %}static {% endif %}{{ var.type }} {{ var.name }}{% if var.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and var.is_protected %} protected{% endif %}{% if var.is_constexpr %} constexpr{% endif %} + {%+ if var.is_static %}static {% endif %}{{ var.type }} {{ var.name }}{% if var.is_deprecated %} deprecated{% endif %}{% if mark_nonpublic and var.is_protected %} protected{% endif %}{% if var.is_constexpr %} constexpr{% endif %} {# This empty line needs to be there otherwise it's eaten #}
diff --git a/documentation/test_doxygen/compound_includes/classClass.html b/documentation/test_doxygen/compound_includes/classClass.html index f7ae88c1..0a065513 100644 --- a/documentation/test_doxygen/compound_includes/classClass.html +++ b/documentation/test_doxygen/compound_includes/classClass.html @@ -40,8 +40,8 @@

Public functions

-
- void foo() +
+ void foo()
No include information for this one (and thus no details)
diff --git a/documentation/test_doxygen/compound_includes/namespaceContained.html b/documentation/test_doxygen/compound_includes/namespaceContained.html index 77d4b21c..1b065ffb 100644 --- a/documentation/test_doxygen/compound_includes/namespaceContained.html +++ b/documentation/test_doxygen/compound_includes/namespaceContained.html @@ -43,8 +43,8 @@

Enums

-
- enum Enum { } +
+ enum Enum { }
An enum.
@@ -52,8 +52,8 @@

Typedefs

-
- using Int = int +
+ using Int = int
A typedef.
@@ -61,8 +61,8 @@

Functions

-
- void foo() +
+ void foo()
A function.
@@ -70,8 +70,8 @@

Variables

-
- const int Var constexpr +
+ const int Var constexpr
A variable.
@@ -79,20 +79,20 @@

A group

-
- enum Flag { } +
+ enum Flag { }
Flag in a group.
-
- using Main = void +
+ using Main = void
Alias in a group.
-
- void* variable constexpr +
+ void* variable constexpr
Variable in a group.
-
- void bar() +
+ void bar()
Function in a group.
diff --git a/documentation/test_doxygen/compound_includes_disabled/classClass.html b/documentation/test_doxygen/compound_includes_disabled/classClass.html index af300410..76333961 100644 --- a/documentation/test_doxygen/compound_includes_disabled/classClass.html +++ b/documentation/test_doxygen/compound_includes_disabled/classClass.html @@ -39,8 +39,8 @@

Public functions

-
- void foo() +
+ void foo()
No include information for this one (and thus no details)
diff --git a/documentation/test_doxygen/compound_includes_disabled/group__group.html b/documentation/test_doxygen/compound_includes_disabled/group__group.html index ff25d6fd..67de4f41 100644 --- a/documentation/test_doxygen/compound_includes_disabled/group__group.html +++ b/documentation/test_doxygen/compound_includes_disabled/group__group.html @@ -40,8 +40,8 @@

Enums

-
- enum Enum { } +
+ enum Enum { }
An enum.
@@ -49,8 +49,8 @@

Typedefs

-
- using Int = int +
+ using Int = int
A typedef.
@@ -58,8 +58,8 @@

Functions

-
- void foo() +
+ void foo()
A function.
@@ -67,8 +67,8 @@

Variables

-
- const int Var constexpr +
+ const int Var constexpr
A variable.
@@ -76,8 +76,8 @@

Defines

-
- #define A_DEFINE +
+ #define A_DEFINE
A define.
diff --git a/documentation/test_doxygen/compound_includes_disabled/namespaceContained.html b/documentation/test_doxygen/compound_includes_disabled/namespaceContained.html index ff344c24..2a5ade42 100644 --- a/documentation/test_doxygen/compound_includes_disabled/namespaceContained.html +++ b/documentation/test_doxygen/compound_includes_disabled/namespaceContained.html @@ -42,8 +42,8 @@

Enums

-
- enum Enum { } +
+ enum Enum { }
An enum.
@@ -51,8 +51,8 @@

Typedefs

-
- using Int = int +
+ using Int = int
A typedef.
@@ -60,8 +60,8 @@

Functions

-
- void foo() +
+ void foo()
A function.
@@ -69,8 +69,8 @@

Variables

-
- const int Var constexpr +
+ const int Var constexpr
A variable.
@@ -78,20 +78,20 @@

A group

-
- enum Flag { } +
+ enum Flag { }
Flag in a group.
-
- using Main = void +
+ using Main = void
Alias in a group.
-
- void* variable constexpr +
+ void* variable constexpr
Variable in a group.
-
- void bar() +
+ void bar()
Function in a group.
diff --git a/documentation/test_doxygen/compound_includes_disabled/namespaceSpread.html b/documentation/test_doxygen/compound_includes_disabled/namespaceSpread.html index c088e0e7..454abbfd 100644 --- a/documentation/test_doxygen/compound_includes_disabled/namespaceSpread.html +++ b/documentation/test_doxygen/compound_includes_disabled/namespaceSpread.html @@ -42,8 +42,8 @@

Enums

-
- enum Enum { } +
+ enum Enum { }
An enum.
@@ -55,8 +55,8 @@

Typedefs

-
- using Int = int +
+ using Int = int
A typedef.
@@ -64,8 +64,8 @@

Functions

-
- void foo() +
+ void foo()
A function.
@@ -73,8 +73,8 @@

Variables

-
- const int Var constexpr +
+ const int Var constexpr
A variable.
@@ -82,20 +82,20 @@

A group

-
- enum Flag { } +
+ enum Flag { }
Flag in a group.
-
- using Main = void +
+ using Main = void
Alias in a group.
-
- void* variable constexpr +
+ void* variable constexpr
Variable in a group.
-
- void bar() +
+ void bar()
Function in a group.
diff --git a/documentation/test_doxygen/compound_listing/File_8h.html b/documentation/test_doxygen/compound_listing/File_8h.html index c1c0b6f3..5cda309a 100644 --- a/documentation/test_doxygen/compound_listing/File_8h.html +++ b/documentation/test_doxygen/compound_listing/File_8h.html @@ -82,8 +82,8 @@

Defines

-
- #define A_DEFINE +
+ #define A_DEFINE
A define.
@@ -91,8 +91,8 @@

A group

-
- #define A_DEFINE_IN_A_GROUP +
+ #define A_DEFINE_IN_A_GROUP
A define in a group.
diff --git a/documentation/test_doxygen/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html b/documentation/test_doxygen/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html index b6f14ea5..a69e47a3 100644 --- a/documentation/test_doxygen/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html +++ b/documentation/test_doxygen/compound_listing/classRoot_1_1Directory_1_1Sub_1_1Class.html @@ -85,12 +85,12 @@ struct Foo
A public subclass.
-
- enum E { FooBar = 3 } +
+ enum E { FooBar = 3 }
A enum value.
-
- using Deleter = void(*)(int, void*) +
+ using Deleter = void(*)(int, void*)
A public typedef.
@@ -98,8 +98,8 @@

Public static variables

-
- static int Size constexpr +
+ static int Size constexpr
A public static var.
@@ -107,8 +107,8 @@

Public static functions

-
- static void damage() +
+ static void damage()
A public static function.
@@ -116,21 +116,21 @@

Constructors, destructors, conversion operators

-
- Class(int, +
+ Class(int, void*) explicit constexpr noexcept
A constructor without parameter names.
-
- Class(Class&) deleted +
+ Class(Class&) deleted
Deleted copy.
-
- operator bool() const && explicit +
+ operator bool() const && explicit
A conversion operator that works only on &&.
-
- ~Class() protected pure virtual +
+ ~Class() protected pure virtual
A protected pure virtual destructor.
@@ -138,8 +138,8 @@

Public functions

-
- auto operator=(Class&&) -> Class& defaulted +
+ auto operator=(Class&&) -> Class& defaulted
Defaulted move.
@@ -147,8 +147,8 @@

Public variables

-
- std::string debug +
+ std::string debug
A public variable.
@@ -161,14 +161,14 @@ union Bar
A protected subclass.
-
- enum Boolean { True, +
+ enum Boolean { True, False, FileNotFound }
Protected enum.
-
- using Type = double +
+ using Type = double
A protected alias.
@@ -176,8 +176,8 @@

Protected static functions

-
- static void repair() +
+ static void repair()
A protected static function.
@@ -185,8 +185,8 @@

Protected functions

-
- auto fetchMeSomeIntegers() const -> int constexpr +
+ auto fetchMeSomeIntegers() const -> int constexpr
Protected function.
@@ -194,8 +194,8 @@

Protected static variables

-
- static bool False +
+ static bool False
A protected static var.
@@ -203,8 +203,8 @@

Protected variables

-
- std::string logger +
+ std::string logger
A protected variable.
@@ -212,8 +212,8 @@

Private functions

-
- auto doSomething() const -> int virtual +
+ auto doSomething() const -> int virtual
A documented private virtual function.
@@ -221,24 +221,24 @@

Group full of non-public stuff which should be marked as such

-
- enum Flag { } protected +
+ enum Flag { } protected
Protected flag in a group.
-
- using Main = void protected +
+ using Main = void protected
Protected alias in a group.
-
- void* variable protected +
+ void* variable protected
Protected variable in a group.
-
- void foo() const & protected +
+ void foo() const & protected
Protected function in a group.
-
- auto doStuff() -> int private pure virtual +
+ auto doStuff() -> int private pure virtual
Private virtual function in a group.
@@ -246,28 +246,28 @@