You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Because dealing with this project is never easy ALWAYS AN ABSOLUTE HORRID NIGHTMARE. Things to do:
Ignoring the new Doxyfile.xml to avoid an assert -- 45911a1
Adapt to changes in how friend classes are listed to avoid an assert -- c7ee89e
Bisect and work around breakage of inline namespaces from 1.9.1 -- in test_doxygen.test_compound.InlineNamespace.test, Foo::Bar and Foo::Bar::Baz are inline, but Foo::Bar::Baz is being listed as Foo::Baz even though stored in namespaceFoo_1_1Bar_1_1Baz.xml and referenced correctly from the parent, hitting an assert. Workaround could be doable but dirty (detecting if inline and extracting from filename).
Bisected to doxygen/doxygen@4372054. OFF COARSE the commit message has no mention of the XML output.
HAVE_DOT has to be explicitly enabled for 1.9.2+ to make graphs appear in XML output -- 901988f
Dot files no longer have an absolute path but are copied to the XML directory instead, handle that (and check how that treats filename conflicts rather not, 'nuff nightmares already) -- e92be04
Certain functions have different hashes (test_doxygen.test_compound.Listing.test_class, test_doxygen.test_cpp.FunctionAttributes.test, test_doxygen.test_search.LongSuffixLength.test), special-case the test files?
test_doxygen.test_compound.Includes no longer exhibits the broken behavior, treating the file where a class was defined as the include file, not the file with a fwdecl; update the test file
test_doxygen/contents_blocks/input.dox:29: warning: End of list marker found without any preceding list items, same on line 39, nothing suspicious in the output, although happening on 1.8.18 already -- tracked already as Incorrect warning regarding end of list doxygen/doxygen#8493, nothing to do here
The damn thing started inserting <zwj/> to random places (test_doxygen.test_contents.Typography.test, test_doxygen.test_contents.Code.test, test_doxygen.test_contents.Blocks.test, log output in test_doxygen.test_contents.AutobriefBlockquote.test). What's the point of that?! -- 58a04dd
wow this is TRULY CURSED as it breaks the already very cursed patching of <p> elements to not be totally insane
Sub-issue, in test_doxygen.test_contents.Typography.test and probably others an indented block (Markdown's <pre>) after a blockquote is no longer treated as such and is instead a plain text. That can be fortunately worked around by putting a . right after the blockquote to separate the two. -- ddec510
Similarly, a code block right after a blockquote is not put into a new paragraph, this needs a new workaround in m.css -- 7581ea0
A bit less excessive spacing around inline elements (test_doxygen.test_contents.Custom.test), update the test file
list of xrefitems has changed order again (test_doxygen.test_contents.Blocks.test_xrefitem, inverse of 4ec09a2), what the hell -- was a temporary 1.8.18-1.8.20 regression, 228c9b8
Run on Magnum docs to discover the remaining 96 new bugs and regressions
The damn thing doesn't understand anchors in Markdown links anymore, so [scalar/vector functions](#scalarvector-functions) leads to a stupid warning: unable to resolve reference to 'scalarvector-functions' for \ref command FFS, I hope the usual HTML links work at least 🙄
unable to resolve reference to 'PixelFormat::RGBA8Unorm/@ref' for \ref command because apparently / is now considered a part of the reference? could be a good thing tho (yeah there's warning: expected whitespace after \ref command for the same line)
warning: unable to resolve reference to 'Platform' for \ref command from a class inside that namespace (basically no link to Platform works for some reason?!)
⚠️ THE DAMN THING no longer knows how to link to stuff defined in parent classes
Magnum/Math/Vector3.h:139: warning: @copybrief or @copydoc target 'Vector::Vector(T)' not found
Magnum/SceneGraph/AbstractTranslationRotation3D.h:210: warning: unable to resolve reference to 'rotate(const Math::Quaternion<T>&)' for \ref command, the original doc work so i suppose this is because the same function is overriden in a subclass with no docstring?
Update the CI to run against 1.9.3
The text was updated successfully, but these errors were encountered:
Something else for this list: It appears that in some recent doxygen version they've changed the way = default is handled, in that now it no longer leaks into the argsstring, meaning that this code isn't strictly correct anymore:
Because dealing with this project is
never easyALWAYS AN ABSOLUTE HORRID NIGHTMARE. Things to do:Doxyfile.xml
to avoid an assert -- 45911a1test_doxygen.test_compound.InlineNamespace.test
,Foo::Bar
andFoo::Bar::Baz
are inline, butFoo::Bar::Baz
is being listed asFoo::Baz
even though stored innamespaceFoo_1_1Bar_1_1Baz.xml
and referenced correctly from the parent, hitting an assert. Workaround could be doable but dirty (detecting if inline and extracting from filename).HAVE_DOT
has to be explicitly enabled for 1.9.2+ to make graphs appear in XML output -- 901988fand check how that treats filename conflictsrather not, 'nuff nightmares already) -- e92be04test_doxygen.test_compound.Listing.test_class
,test_doxygen.test_cpp.FunctionAttributes.test
,test_doxygen.test_search.LongSuffixLength.test
), special-case the test files?test_doxygen.test_compound.Includes
no longer exhibits the broken behavior, treating the file where a class was defined as the include file, not the file with a fwdecl; update the test filetest_doxygen/contents_blocks/input.dox:29: warning: End of list marker found without any preceding list items
, same on line 39, nothing suspicious in the output, although happening on 1.8.18 already -- tracked already as Incorrect warning regarding end of list doxygen/doxygen#8493, nothing to do here<zwj/>
to random places (test_doxygen.test_contents.Typography.test
,test_doxygen.test_contents.Code.test
,test_doxygen.test_contents.Blocks.test
, log output intest_doxygen.test_contents.AutobriefBlockquote.test
). What's the point of that?! -- 58a04dd<p>
elements to not be totally insanetest_doxygen.test_contents.Typography.test
and probably others an indented block (Markdown's<pre>
) after a blockquote is no longer treated as such and is instead a plain text. That can be fortunately worked around by putting a.
right after the blockquote to separate the two. -- ddec510test_doxygen.test_contents.Custom.test
), update the test filetest_doxygen.test_contents.Blocks.test_xrefitem
, inverse of 4ec09a2), what the hell -- was a temporary 1.8.18-1.8.20 regression, 228c9b8<memberdef>
s in XML output doxygen/doxygen#8983, XML files now include<qualname>
elements, which could help with restoring scopes in file docs?warning: documented empty return type of
, fix the test files -- 568edda, a0a0032* *foo*
instead of*foo*
, investigate the impact (Markdown **emphasis** at the beginning of the line is not rendered. doxygen/doxygen#8615)[scalar/vector functions](#scalarvector-functions)
leads to a stupidwarning: unable to resolve reference to 'scalarvector-functions' for \ref command
FFS, I hope the usual HTML links work at least 🙄unable to resolve reference to 'PixelFormat::RGBA8Unorm/@ref' for \ref command
because apparently/
is now considered a part of the reference? could be a good thing tho (yeah there'swarning: expected whitespace after \ref command
for the same line)warning: unable to resolve reference to 'Platform' for \ref command
from a class inside that namespace (basically no link toPlatform
works for some reason?!)Magnum/Math/Vector3.h:139: warning: @copybrief or @copydoc target 'Vector::Vector(T)' not found
Magnum/SceneGraph/AbstractTranslationRotation3D.h:210: warning: unable to resolve reference to 'rotate(const Math::Quaternion<T>&)' for \ref command
, the original doc work so i suppose this is because the same function is overriden in a subclass with no docstring?The text was updated successfully, but these errors were encountered: