chiark / gitweb /
m.dox: test & fix linking to files, defines and macros.
authorVladimír Vondruš <mosra@centrum.cz>
Tue, 4 Oct 2022 10:13:46 +0000 (12:13 +0200)
committerVladimír Vondruš <mosra@centrum.cz>
Tue, 4 Oct 2022 10:55:57 +0000 (12:55 +0200)
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
plugins/m/dox.py
plugins/m/test/dox/page.html
plugins/m/test/dox/page.rst
plugins/m/test/dox/page_css_classes.html

index 16a5d59c30fb842ab3fa5abf716c09be13f36249..a711b563ca6c062978185a12422bbcfeaee6a760 100644 (file)
     <title>Plugin management</title>
     <filename>plugin-management</filename>
   </compound>
+  <compound kind="file">
+    <name>Corrade.h</name>
+    <path>/home/mosra/Code/corrade/src/Corrade/</path>
+    <filename>Corrade_8h.html</filename>
+    <member kind="define">
+      <type>#define</type>
+      <name>CORRADE_TARGET_AVX512F</name>
+      <anchorfile>Corrade_8h.html</anchorfile>
+      <anchor>a9238a5d202ed321a0435d2885e2ff47c</anchor>
+      <arglist></arglist>
+    </member>
+  </compound>
+  <compound kind="file">
+    <name>Assert.h</name>
+    <path>/home/mosra/Code/corrade/src/Corrade/Utility/</path>
+    <filename>Assert_8h.html</filename>
+    <member kind="define">
+      <type>#define</type>
+      <name>CORRADE_ASSERT</name>
+      <anchorfile>Assert_8h.html</anchorfile>
+      <anchor>a83f7361970111951c88f1564a4f148e8</anchor>
+      <arglist>(condition, message, returnValue)</arglist>
+    </member>
+  </compound>
 </tagfile>
index 3c9b1346305fa52015cb78810639570b853a2095..5751cb82d06422e282f8619f2ffe36583a67326b 100644 (file)
@@ -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':
index dad719aff448a3627ada6f43b13ab953245bf4cb..d2d8dfc43a73398e554a8f7e4a3ba5b3756ff803 100644 (file)
 <li>Function link: <a href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#a41321c89e0d8f23bdfb5b1b876b3ab82">Utility::Path::make()</a></li>
 <li>Class link: <a href="https://doc.magnum.graphics/corrade/classCorrade_1_1Containers_1_1String.html">Containers::String</a></li>
 <li>Page link: <a href="https://doc.magnum.graphics/corrade/building-corrade.html">Downloading and building Corrade</a></li>
+<li>File link: <a href="https://doc.magnum.graphics/corrade/Corrade_8h.html">/home/mosra/Code/corrade/src/Corrade/Corrade.h</a></li>
 <li>Typedef link: <a href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Containers.html#a5ac77ad25e27290ff059450af138fbed">Containers::StringView</a></li>
 <li>Enum link: <a href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#aaedb816dc129cca78cbe29c2846f3c74">Utility::Path::ListFlag</a></li>
 <li>Enum value link: <a href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#aaedb816dc129cca78cbe29c2846f3c74a9011abdfaf22b80f4ae98a3f59fed46b">Utility::Path::ListFlag::SkipDirectories</a></li>
+<li>Define link: <a href="https://doc.magnum.graphics/corrade/Corrade_8h.html#a9238a5d202ed321a0435d2885e2ff47c">CORRADE_TARGET_AVX512F</a></li>
+<li>Macro function link: <a href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8">CORRADE_ASSERT()</a></li>
 <li>Variable link: <a href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Containers.html#a1f81c0df1f144ff03f4f02f6721f615b">Containers::AllocatedInit</a></li>
 <li><a href="https://doc.magnum.graphics/corrade/testsuite.html">Custom link title</a></li>
 <li><a href="https://doc.magnum.graphics/corrade/corrade-cmake.html">Page link with custom title</a></li>
index d467e1ce79e1bd0e34112ef5c38e4aedc0384294..b51ae0be38bcb68494b02b6b472009ae696096cd 100644 (file)
@@ -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 <testsuite>`
 -   :dox:`Page link with custom title <corrade-cmake>`
index 682eef13ba7b7035fd8d42db3a14702630f22fdc..fa000c637a370c4c9c764ed49c9ed57ddf0a8695 100644 (file)
 <li>Function link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#a41321c89e0d8f23bdfb5b1b876b3ab82">Utility::Path::make()</a></li>
 <li>Class link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/classCorrade_1_1Containers_1_1String.html">Containers::String</a></li>
 <li>Page link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/building-corrade.html">Downloading and building Corrade</a></li>
+<li>File link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/Corrade_8h.html">/home/mosra/Code/corrade/src/Corrade/Corrade.h</a></li>
 <li>Typedef link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Containers.html#a5ac77ad25e27290ff059450af138fbed">Containers::StringView</a></li>
 <li>Enum link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#aaedb816dc129cca78cbe29c2846f3c74">Utility::Path::ListFlag</a></li>
 <li>Enum value link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Utility_1_1Path.html#aaedb816dc129cca78cbe29c2846f3c74a9011abdfaf22b80f4ae98a3f59fed46b">Utility::Path::ListFlag::SkipDirectories</a></li>
+<li>Define link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/Corrade_8h.html#a9238a5d202ed321a0435d2885e2ff47c">CORRADE_TARGET_AVX512F</a></li>
+<li>Macro function link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/Assert_8h.html#a83f7361970111951c88f1564a4f148e8">CORRADE_ASSERT()</a></li>
 <li>Variable link: <a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/namespaceCorrade_1_1Containers.html#a1f81c0df1f144ff03f4f02f6721f615b">Containers::AllocatedInit</a></li>
 <li><a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/testsuite.html">Custom link title</a></li>
 <li><a class="m-flat m-text m-strong" href="https://doc.magnum.graphics/corrade/corrade-cmake.html">Page link with custom title</a></li>