From a818285f0876c70810b7eb529736e321033973a2 Mon Sep 17 00:00:00 2001 From: =?utf8?q?Vladim=C3=ADr=20Vondru=C5=A1?= Date: Tue, 4 Oct 2022 12:13:46 +0200 Subject: [PATCH] m.dox: test & fix linking to files, defines and macros. The tagfile has an absolute path for some reason, but not going to bother with that right now. The code was also appending one extra .html extension, which is fixed. --- doc/documentation/corrade.tag | 24 ++++++++++++++++++++++++ plugins/m/dox.py | 4 ++-- plugins/m/test/dox/page.html | 3 +++ plugins/m/test/dox/page.rst | 3 +++ plugins/m/test/dox/page_css_classes.html | 3 +++ 5 files changed, 35 insertions(+), 2 deletions(-) diff --git a/doc/documentation/corrade.tag b/doc/documentation/corrade.tag index 16a5d59c..a711b563 100644 --- a/doc/documentation/corrade.tag +++ b/doc/documentation/corrade.tag @@ -68,4 +68,28 @@ Plugin management plugin-management + + Corrade.h + /home/mosra/Code/corrade/src/Corrade/ + Corrade_8h.html + + #define + CORRADE_TARGET_AVX512F + Corrade_8h.html + a9238a5d202ed321a0435d2885e2ff47c + + + + + Assert.h + /home/mosra/Code/corrade/src/Corrade/Utility/ + Assert_8h.html + + #define + CORRADE_ASSERT + Assert_8h.html + a83f7361970111951c88f1564a4f148e8 + (condition, message, returnValue) + + diff --git a/plugins/m/dox.py b/plugins/m/dox.py index 3c9b1346..5751cb82 100644 --- a/plugins/m/dox.py +++ b/plugins/m/dox.py @@ -79,7 +79,7 @@ def init(tagfiles, input): # Linking to files if child.attrib['kind'] == 'file': file_path = child.find('path') - link = path + child.find('filename').text + ".html" + link = path + child.find('filename').text symbol_mapping[(file_path.text if file_path is not None else '') + child.find('name').text] = (None, link, css_classes) for member in child.findall('member'): @@ -99,7 +99,7 @@ def init(tagfiles, input): # Typedefs, constants, variables if member.attrib['kind'] in ['typedef', 'enumvalue', 'variable']: - symbol_mapping[name + '::' + member.find('name').text] = (None, link + '#' + member.find('anchor').text, css_classes) + symbol_mapping[name + '::' + member.find('name').text] = (None, link + '#' + member.findtext('anchor'), css_classes) # Functions if member.attrib['kind'] == 'function': diff --git a/plugins/m/test/dox/page.html b/plugins/m/test/dox/page.html index dad719af..d2d8dfc4 100644 --- a/plugins/m/test/dox/page.html +++ b/plugins/m/test/dox/page.html @@ -27,9 +27,12 @@
  • Function link: Utility::Path::make()
  • Class link: Containers::String
  • Page link: Downloading and building Corrade
    • +
  • File link: /home/mosra/Code/corrade/src/Corrade/Corrade.h
  • Typedef link: Containers::StringView
  • Enum link: Utility::Path::ListFlag
  • Enum value link: Utility::Path::ListFlag::SkipDirectories
    • +
  • Define link: CORRADE_TARGET_AVX512F
    • +
  • Macro function link: CORRADE_ASSERT()
  • Variable link: Containers::AllocatedInit
  • Custom link title
  • Page link with custom title
    • diff --git a/plugins/m/test/dox/page.rst b/plugins/m/test/dox/page.rst index d467e1ce..b51ae0be 100644 --- a/plugins/m/test/dox/page.rst +++ b/plugins/m/test/dox/page.rst @@ -7,9 +7,12 @@ m.dox - Function link: :dox:`Utility::Path::make()` - Class link: :dox:`Containers::String` - Page link: :dox:`building-corrade` +- File link: :dox:`/home/mosra/Code/corrade/src/Corrade/Corrade.h` - Typedef link: :dox:`Containers::StringView` - Enum link: :dox:`Utility::Path::ListFlag` - Enum value link: :dox:`Utility::Path::ListFlag::SkipDirectories` +- Define link: :dox:`CORRADE_TARGET_AVX512F` +- Macro function link: :dox:`CORRADE_ASSERT()` - Variable link: :dox:`Containers::AllocatedInit` - :dox:`Custom link title ` - :dox:`Page link with custom title ` diff --git a/plugins/m/test/dox/page_css_classes.html b/plugins/m/test/dox/page_css_classes.html index 682eef13..fa000c63 100644 --- a/plugins/m/test/dox/page_css_classes.html +++ b/plugins/m/test/dox/page_css_classes.html @@ -27,9 +27,12 @@
  • Function link: Utility::Path::make()
  • Class link: Containers::String
  • Page link: Downloading and building Corrade
    • +
  • File link: /home/mosra/Code/corrade/src/Corrade/Corrade.h
  • Typedef link: Containers::StringView
  • Enum link: Utility::Path::ListFlag
  • Enum value link: Utility::Path::ListFlag::SkipDirectories
    • +
  • Define link: CORRADE_TARGET_AVX512F
    • +
  • Macro function link: CORRADE_ASSERT()
  • Variable link: Containers::AllocatedInit
  • Custom link title
  • Page link with custom title
    • -- 2.30.2