chiark / gitweb /
blog.git
7 years agodoxygen: don't include function parameter names in search results.
Vladimír Vondruš [Sun, 28 Jan 2018 21:45:02 +0000 (22:45 +0100)]
doxygen: don't include function parameter names in search results.

Too damn long.

7 years agodoxygen: strip HTML tags from function param types in search.
Vladimír Vondruš [Sun, 28 Jan 2018 21:30:18 +0000 (22:30 +0100)]
doxygen: strip HTML tags from function param types in search.

7 years agodoxygen: search result clarity improvements.
Vladimír Vondruš [Sun, 28 Jan 2018 19:56:27 +0000 (20:56 +0100)]
doxygen: search result clarity improvements.

 * Function/macro params and suffix (such as const&&) is included in
   search results.
 * Directories are displayed with / at the end.
 * Parent pages are included in the name.

In order to properly highlight the typed value, a new "suffix length"
field is introduced in the result map, saying how much text there
is after the matching trie entry.

Also, in order to display the right angle quote for subpages, a bunch of
UTF-8-awareness fixes was done across the code.

7 years agopackage/ci: JS testing on Travis.
Vladimír Vondruš [Sat, 27 Jan 2018 16:41:00 +0000 (17:41 +0100)]
package/ci: JS testing on Travis.

7 years agodoxygen: updated docs about unit testing and coverage to include JS.
Vladimír Vondruš [Sat, 27 Jan 2018 16:40:36 +0000 (17:40 +0100)]
doxygen: updated docs about unit testing and coverage to include JS.

7 years agodoxygen: fix case where pages are subpages of index.
Vladimír Vondruš [Mon, 29 Jan 2018 22:46:10 +0000 (23:46 +0100)]
doxygen: fix case where pages are subpages of index.

Avoid the assertion, include the index page in the page tree and link to
index.html instead of indexpage.html.

7 years agodoxygen: don't die if a page doesn't have a title.
Vladimír Vondruš [Mon, 29 Jan 2018 18:39:17 +0000 (19:39 +0100)]
doxygen: don't die if a page doesn't have a title.

But use its name instead.

7 years agodoxygen: initial client-side search implementation.
Vladimír Vondruš [Tue, 23 Jan 2018 09:35:16 +0000 (10:35 +0100)]
doxygen: initial client-side search implementation.

7 years agodoxygen: save half of node size, as it is aligned to 16bit.
Vladimír Vondruš [Sat, 20 Jan 2018 22:53:54 +0000 (23:53 +0100)]
doxygen: save half of node size, as it is aligned to 16bit.

Makes it possible to run on the whole Magnum symbol tree.

7 years agodoxygen: assert that the search trie consists only of lowercase data.
Vladimír Vondruš [Sat, 20 Jan 2018 22:55:35 +0000 (23:55 +0100)]
doxygen: assert that the search trie consists only of lowercase data.

Can't use `assert c.islower()` as that returns False on non-alnum chars.
Huh.

7 years agodoxygen: serializing search result map and everything together.
Vladimír Vondruš [Sat, 20 Jan 2018 22:39:00 +0000 (23:39 +0100)]
doxygen: serializing search result map and everything together.

7 years agodoxygen: ability to print trie stats in the pretty printer.
Vladimír Vondruš [Sat, 20 Jan 2018 17:56:23 +0000 (18:56 +0100)]
doxygen: ability to print trie stats in the pretty printer.

7 years agodoxygen: implement subtree merging.
Vladimír Vondruš [Sat, 20 Jan 2018 14:54:23 +0000 (15:54 +0100)]
doxygen: implement subtree merging.

Reduces size of the test case from 514 bytes to 340. Also the
visualization tool can visualize where the trees were cut off.

7 years agodoxygen: ability to use the pretty trie printer from a command-line.
Vladimír Vondruš [Sat, 20 Jan 2018 22:49:08 +0000 (23:49 +0100)]
doxygen: ability to use the pretty trie printer from a command-line.

7 years agodoxygen: initial Trie building & serialization implementation.
Vladimír Vondruš [Fri, 19 Jan 2018 21:54:42 +0000 (22:54 +0100)]
doxygen: initial Trie building & serialization implementation.

7 years agodoxygen: loudly ignore member groups without a \name instead of asserting.
Vladimír Vondruš [Tue, 30 Jan 2018 11:48:38 +0000 (12:48 +0100)]
doxygen: loudly ignore member groups without a \name instead of asserting.

7 years agodoxygen: render Reference in TOC only if there is some reference.
Vladimír Vondruš [Mon, 29 Jan 2018 22:47:32 +0000 (23:47 +0100)]
doxygen: render Reference in TOC only if there is some reference.

7 years agodoxygen: don't be so strict about directory parents.
Vladimír Vondruš [Mon, 29 Jan 2018 22:23:35 +0000 (23:23 +0100)]
doxygen: don't be so strict about directory parents.

There can be quite a mess.

7 years agodoxygen: fix section merging with return value docs involved.
Vladimír Vondruš [Mon, 29 Jan 2018 22:04:58 +0000 (23:04 +0100)]
doxygen: fix section merging with return value docs involved.

7 years agodoxygen: more flexible table rendering.
Vladimír Vondruš [Mon, 29 Jan 2018 21:12:39 +0000 (22:12 +0100)]
doxygen: more flexible table rendering.

Support more consecutive table header rows, allow <th> elements inside
<tbody>.

7 years agodoxygen: support `\param x, y, z Description`.
Vladimír Vondruš [Mon, 29 Jan 2018 20:56:25 +0000 (21:56 +0100)]
doxygen: support `\param x, y, z Description`.

Oh, so that explains the massive complexity of the XML output. Ugh.

7 years agodoxygen: don't die on empty elements.
Vladimír Vondruš [Mon, 29 Jan 2018 20:39:55 +0000 (21:39 +0100)]
doxygen: don't die on empty elements.

Include the block ones in the output, remove the inline ones.

7 years agodoxygen: support math formulas in custom environment.
Vladimír Vondruš [Mon, 29 Jan 2018 20:28:58 +0000 (21:28 +0100)]
doxygen: support math formulas in custom environment.

And also be more generous with spacing.

7 years agodoxygen: groups can have inner classes, too.
Vladimír Vondruš [Mon, 29 Jan 2018 20:15:27 +0000 (21:15 +0100)]
doxygen: groups can have inner classes, too.

7 years agodoxygen: more flexible function argument array parsing.
Vladimír Vondruš [Mon, 29 Jan 2018 20:15:01 +0000 (21:15 +0100)]
doxygen: more flexible function argument array parsing.

7 years agodoxygen: be less strict when parsing \param and \return.
Vladimír Vondruš [Mon, 29 Jan 2018 20:03:39 +0000 (21:03 +0100)]
doxygen: be less strict when parsing \param and \return.

They can be scattered around the documentation block, in different
paragraphs. Combine them together and reorder as they should be.

7 years agodoxygen: don't die on XML parse error.
Vladimír Vondruš [Mon, 29 Jan 2018 19:49:14 +0000 (20:49 +0100)]
doxygen: don't die on XML parse error.

Doxygen is able to highlight PNGs as C++ code. It's amazing, of
course, but the result is a terrible mess (of course). So let's have
another drink and ignore those *amazing things*.

7 years agodoxygen: complain instead of blowing up if more \return-s are present.
Vladimír Vondruš [Mon, 29 Jan 2018 18:53:24 +0000 (19:53 +0100)]
doxygen: complain instead of blowing up if more \return-s are present.

7 years agodoxygen: make it possible to call this script from an arbitrary dir.
Vladimír Vondruš [Sat, 27 Jan 2018 18:31:47 +0000 (19:31 +0100)]
doxygen: make it possible to call this script from an arbitrary dir.

Finally. One step closer to having a pip package.

7 years agodoxygen: initial support for modules.
Vladimír Vondruš [Mon, 29 Jan 2018 17:50:12 +0000 (18:50 +0100)]
doxygen: initial support for modules.

Module reference, module index, detecting module hierarchy for
breadcrumb and index.

7 years agodoxygen: generate empty index page in case nothing is supplied for it.
Vladimír Vondruš [Mon, 29 Jan 2018 16:27:13 +0000 (17:27 +0100)]
doxygen: generate empty index page in case nothing is supplied for it.

So the documentation has some entry point.

7 years agodoxygen: ignore RCS strings to avoid assertions.
Vladimír Vondruš [Mon, 29 Jan 2018 15:35:05 +0000 (16:35 +0100)]
doxygen: ignore RCS strings to avoid assertions.

7 years agodoxygen: support <pre> tags.
Vladimír Vondruš [Mon, 29 Jan 2018 10:55:09 +0000 (11:55 +0100)]
doxygen: support <pre> tags.

I can't comprehend why there is a separate <verbatim> and
<preformatted> tag.

7 years agodoxygen: solve all problems of mankind by making paths absolute.
Vladimír Vondruš [Mon, 29 Jan 2018 12:45:41 +0000 (13:45 +0100)]
doxygen: solve all problems of mankind by making paths absolute.

7 years agoExclude test directories from coverage report.
Vladimír Vondruš [Sun, 28 Jan 2018 14:54:11 +0000 (15:54 +0100)]
Exclude test directories from coverage report.

7 years agopackage/ci: no need to pretend that we have coverage for Jinja2.
Vladimír Vondruš [Sun, 28 Jan 2018 14:53:40 +0000 (15:53 +0100)]
package/ci: no need to pretend that we have coverage for Jinja2.

7 years agodoxygen: try to test more stuff on 1.8.13.
Vladimír Vondruš [Sun, 28 Jan 2018 14:53:13 +0000 (15:53 +0100)]
doxygen: try to test more stuff on 1.8.13.

7 years agocss: clean up and remove redundant stuff from header styling.
Vladimír Vondruš [Thu, 25 Jan 2018 18:03:44 +0000 (19:03 +0100)]
css: clean up and remove redundant stuff from header styling.

By accident the spacing between items was 1.75rem, now it's 2rem. Maybe
too much (but perfectly okay for submenus and the mobile layout), might
change later.

7 years agoAdded codecov.io badge to README.
Vladimír Vondruš [Sat, 27 Jan 2018 18:31:26 +0000 (19:31 +0100)]
Added codecov.io badge to README.

7 years agopackage/ci: upload code coverage to codecov.io.
Vladimír Vondruš [Sat, 27 Jan 2018 17:46:57 +0000 (18:46 +0100)]
package/ci: upload code coverage to codecov.io.

7 years agosite: enable the math-as-code fallback.
Vladimír Vondruš [Mon, 22 Jan 2018 13:16:55 +0000 (14:16 +0100)]
site: enable the math-as-code fallback.

7 years agom.math: ability of fallback to rendering math as code blocks.
Vladimír Vondruš [Mon, 22 Jan 2018 13:13:28 +0000 (14:13 +0100)]
m.math: ability of fallback to rendering math as code blocks.

7 years agom.code: properly preserve backslashes in inline :code:.
Vladimír Vondruš [Mon, 22 Jan 2018 12:10:55 +0000 (13:10 +0100)]
m.code: properly preserve backslashes in inline :code:.

The test now passes again.

7 years agom.code: test that backslashes in inline :code: are properly preserved.
Vladimír Vondruš [Mon, 22 Jan 2018 12:10:04 +0000 (13:10 +0100)]
m.code: test that backslashes in inline :code: are properly preserved.

They are not.

7 years agodoc: properly specify the :css: interpreted text role in doxygen.rst.
Vladimír Vondruš [Mon, 22 Jan 2018 08:06:48 +0000 (09:06 +0100)]
doc: properly specify the :css: interpreted text role in doxygen.rst.

7 years agodoc: document base/derived classes in the doxygen template.
Vladimír Vondruš [Sat, 20 Jan 2018 14:45:06 +0000 (15:45 +0100)]
doc: document base/derived classes in the doxygen template.

7 years agodoxygen: aaand now the coverage is 100%.
Vladimír Vondruš [Thu, 18 Jan 2018 22:07:05 +0000 (23:07 +0100)]
doxygen: aaand now the coverage is 100%.

7 years agodoxygen: warn when export macros are spotted in the output.
Vladimír Vondruš [Thu, 18 Jan 2018 20:39:29 +0000 (21:39 +0100)]
doxygen: warn when export macros are spotted in the output.

7 years agodoxygen: test that example pages work even without breadcrumb/footer nav.
Vladimír Vondruš [Thu, 18 Jan 2018 20:25:36 +0000 (21:25 +0100)]
doxygen: test that example pages work even without breadcrumb/footer nav.

7 years agodoxygen: properly ignore empty/private documentation pages.
Vladimír Vondruš [Thu, 18 Jan 2018 20:20:23 +0000 (21:20 +0100)]
doxygen: properly ignore empty/private documentation pages.

7 years agodoxygen: dedicated test for ignoring empty documentation files.
Vladimír Vondruš [Thu, 18 Jan 2018 20:20:00 +0000 (21:20 +0100)]
doxygen: dedicated test for ignoring empty documentation files.

7 years agodoxygen: skip the example test on Doxygen < 1.8.14.
Vladimír Vondruš [Thu, 18 Jan 2018 14:08:55 +0000 (15:08 +0100)]
doxygen: skip the example test on Doxygen < 1.8.14.

7 years agodoxygen: remove pointless restrictions for valid use cases.
Vladimír Vondruš [Thu, 18 Jan 2018 14:00:12 +0000 (15:00 +0100)]
doxygen: remove pointless restrictions for valid use cases.

And add a test there.

7 years agodoxygen: list base and derived classes.
Vladimír Vondruš [Thu, 18 Jan 2018 13:14:29 +0000 (14:14 +0100)]
doxygen: list base and derived classes.

7 years agodoxygen: moved test for \m_footernavigation to a better place.
Vladimír Vondruš [Thu, 18 Jan 2018 12:50:23 +0000 (13:50 +0100)]
doxygen: moved test for \m_footernavigation to a better place.

Because I was searching for it everywhere but here.

7 years agodoxygen: new \m_examplenavigation command.
Vladimír Vondruš [Thu, 18 Jan 2018 12:48:04 +0000 (13:48 +0100)]
doxygen: new \m_examplenavigation command.

This tests the example page for the first time. So I took the
opportunity and also renamed the title suffix to "source" instead of
"example".

7 years agosite: build status page.
Vladimír Vondruš [Thu, 18 Jan 2018 12:11:17 +0000 (13:11 +0100)]
site: build status page.

Basically stolen from Magnum.

7 years agom.gl: ability to link to WebGL extensions.
Vladimír Vondruš [Thu, 18 Jan 2018 12:10:29 +0000 (13:10 +0100)]
m.gl: ability to link to WebGL extensions.

7 years agodoc++
Vladimír Vondruš [Thu, 18 Jan 2018 12:10:10 +0000 (13:10 +0100)]
doc++

7 years agopackage/ci: assign unique IDs to builds.
Vladimír Vondruš [Thu, 18 Jan 2018 11:55:18 +0000 (12:55 +0100)]
package/ci: assign unique IDs to builds.

So I can display them in the build status.

7 years agoRevert "package/ci: use Doxygen 1.8.14 on Travis."
Vladimír Vondruš [Thu, 18 Jan 2018 10:40:42 +0000 (11:40 +0100)]
Revert "package/ci: use Doxygen 1.8.14 on Travis."

It depends on libclang.so.6 which is ... well, nowhere to be found.

This reverts commit 4fce7d16e1ab3167fd4f097b504d25c6350d7a93.

7 years agocss: updated postprocessed files.
Vladimír Vondruš [Wed, 17 Jan 2018 00:45:32 +0000 (01:45 +0100)]
css: updated postprocessed files.

7 years agocss: ability to inflate spacing of .m-table by putting .m-big on it.
Vladimír Vondruš [Wed, 17 Jan 2018 00:44:38 +0000 (01:44 +0100)]
css: ability to inflate spacing of .m-table by putting .m-big on it.

7 years agocss: properly restrict styling to tables marked as .m-table.
Vladimír Vondruš [Wed, 17 Jan 2018 00:43:40 +0000 (01:43 +0100)]
css: properly restrict styling to tables marked as .m-table.

7 years agocss: ability to put .m-thin on <th> elements.
Vladimír Vondruš [Wed, 17 Jan 2018 00:42:55 +0000 (01:42 +0100)]
css: ability to put .m-thin on <th> elements.

7 years agocss: ability to align text vertically in a table cell.
Vladimír Vondruš [Wed, 17 Jan 2018 00:40:28 +0000 (01:40 +0100)]
css: ability to align text vertically in a table cell.

7 years agoAbility to show list of latest news on the index page.
Vladimír Vondruš [Wed, 17 Jan 2018 00:10:36 +0000 (01:10 +0100)]
Ability to show list of latest news on the index page.

7 years agosite: update index page styling.
Vladimír Vondruš [Tue, 16 Jan 2018 23:20:19 +0000 (00:20 +0100)]
site: update index page styling.

I'm overusing this thing.

7 years agosite: added favicon.
Vladimír Vondruš [Tue, 16 Jan 2018 23:20:06 +0000 (00:20 +0100)]
site: added favicon.

7 years agotheme: ability to specify a favicon.
Vladimír Vondruš [Tue, 16 Jan 2018 23:15:30 +0000 (00:15 +0100)]
theme: ability to specify a favicon.

7 years agodoxygen: ability to specify favicon.
Vladimír Vondruš [Tue, 16 Jan 2018 22:30:30 +0000 (23:30 +0100)]
doxygen: ability to specify favicon.

7 years agodoxygen: name the function better.
Vladimír Vondruš [Tue, 16 Jan 2018 22:22:24 +0000 (23:22 +0100)]
doxygen: name the function better.

7 years agodoc: link to live version of the Doxygen theme.
Vladimír Vondruš [Tue, 16 Jan 2018 21:31:11 +0000 (22:31 +0100)]
doc: link to live version of the Doxygen theme.

7 years agodoxygen: make it possible to override top navbar links.
Vladimír Vondruš [Tue, 16 Jan 2018 21:29:23 +0000 (22:29 +0100)]
doxygen: make it possible to override top navbar links.

7 years agodoxygen: remove M_SHOW_DOXYGEN_VERSION setting.
Vladimír Vondruš [Tue, 16 Jan 2018 18:23:59 +0000 (19:23 +0100)]
doxygen: remove M_SHOW_DOXYGEN_VERSION setting.

Was used only for testing, can be supplemented by modifying
M_PAGE_FINE_PRINT.

7 years agodoxygen: make it possible to hide the footer altogether.
Vladimír Vondruš [Tue, 16 Jan 2018 17:51:39 +0000 (18:51 +0100)]
doxygen: make it possible to hide the footer altogether.

Makes testing much easier.

7 years agodoxygen: test overriding properties, not hiding them, in layout test.
Vladimír Vondruš [Tue, 16 Jan 2018 17:43:10 +0000 (18:43 +0100)]
doxygen: test overriding properties, not hiding them, in layout test.

7 years agodoxygen: test layout with minimal Doxyfile.
Vladimír Vondruš [Tue, 16 Jan 2018 17:37:37 +0000 (18:37 +0100)]
doxygen: test layout with minimal Doxyfile.

7 years agotheme: support for archived articles.
Vladimír Vondruš [Tue, 16 Jan 2018 17:03:45 +0000 (18:03 +0100)]
theme: support for archived articles.

7 years agotheme: different styling for updated articles in the footer.
Vladimír Vondruš [Tue, 16 Jan 2018 13:03:29 +0000 (14:03 +0100)]
theme: different styling for updated articles in the footer.

7 years agom.dox: some patches to make this work with the cppreference tag file.
Vladimír Vondruš [Tue, 16 Jan 2018 12:54:29 +0000 (13:54 +0100)]
m.dox: some patches to make this work with the cppreference tag file.

7 years agoAdded flat button style.
Vladimír Vondruš [Tue, 16 Jan 2018 12:53:43 +0000 (13:53 +0100)]
Added flat button style.

7 years agocss: separately configurable value for button background color.
Vladimír Vondruš [Tue, 16 Jan 2018 11:45:09 +0000 (12:45 +0100)]
css: separately configurable value for button background color.

In particular, had to use a darker color than the default background
color of the dark theme as the contrast was too little with danger and
info buttons.

7 years agocss: At least some padding on full-width buttons.
Vladimír Vondruš [Tue, 16 Jan 2018 11:42:57 +0000 (12:42 +0100)]
css: At least some padding on full-width buttons.

When tucking the full-width buttons in a table that had many columns
there was no padding at all, looking extra ugly.

7 years agocss: removed min-width of header menu sub items.
Vladimír Vondruš [Tue, 16 Jan 2018 11:41:46 +0000 (12:41 +0100)]
css: removed min-width of header menu sub items.

Caused horizontal scrollbar when the rightmost item had a submenu. Now
it's a bit ugly, but at least without the scrollbar.

7 years agocss: make also the bottom rounded on flat figures.
Vladimír Vondruš [Tue, 9 Jan 2018 21:30:21 +0000 (22:30 +0100)]
css: make also the bottom rounded on flat figures.

It looks weirdly cut off when there is no border.

7 years agocss: figure border radius should be configurable as well.
Vladimír Vondruš [Tue, 9 Jan 2018 21:30:00 +0000 (22:30 +0100)]
css: figure border radius should be configurable as well.

7 years agocss: updated postprocessed files.
Vladimír Vondruš [Fri, 5 Jan 2018 16:44:56 +0000 (17:44 +0100)]
css: updated postprocessed files.

7 years agocss: for some reason div.m-scroll was missing from here.
Vladimír Vondruš [Fri, 5 Jan 2018 16:43:50 +0000 (17:43 +0100)]
css: for some reason div.m-scroll was missing from here.

7 years agocss: rework button markup.
Vladimír Vondruš [Fri, 5 Jan 2018 16:39:31 +0000 (17:39 +0100)]
css: rework button markup.

Default to centered button, because that's what one usually wants. This
also resolves the problem with the following markup not having spacing
after and thus being too sticky to content that immediately follows it.

    <div class="m-text-centered">
      <a class="m-button m-success" href="#">...</a>
    </div>

The new markup is thus this, the .m-text-centered class no longer
needed. Adding .m-fullwidth to the <div> works as expected.

    <div class="m-button m-success">
      <a href="#">...</a>
    </div>

Sorry for potential breakages of your content.

7 years agosite: updated footer.
Vladimír Vondruš [Fri, 5 Jan 2018 00:51:26 +0000 (01:51 +0100)]
site: updated footer.

No silly jokes anymore. THIS IS SERIOUS SHIT, YA?

7 years agodoxygen: improve diagnostic output.
Vladimír Vondruš [Fri, 5 Jan 2018 00:32:10 +0000 (01:32 +0100)]
doxygen: improve diagnostic output.

Not printing info about every file in the default case anymore, printing
just the warnings. In order to make that usable, all warnings are now
prefixed with name of file that's being processed.

Documentation goal, like with stock Doxygen, is to have zero console
output.

7 years agocss: updated postprocessed files.
Vladimír Vondruš [Fri, 5 Jan 2018 00:29:25 +0000 (01:29 +0100)]
css: updated postprocessed files.

7 years agocss: better color for cover image background.
Vladimír Vondruš [Fri, 5 Jan 2018 00:28:24 +0000 (01:28 +0100)]
css: better color for cover image background.

The previous was too much grey and too little blue.

7 years agocss: improved styling for landing page title.
Vladimír Vondruš [Fri, 5 Jan 2018 00:27:12 +0000 (01:27 +0100)]
css: improved styling for landing page title.

It's a bit bigger now, with some more padding around and a possibility
to control its casing.

7 years agocss: fix jumbo article header behavior on very narrow / very wide screens.
Vladimír Vondruš [Fri, 5 Jan 2018 00:23:09 +0000 (01:23 +0100)]
css: fix jumbo article header behavior on very narrow / very wide screens.

In some cases the content after got floated right after the article
title, on iOS Safari the content was even overlapping the header. Also
added a minimal font size so the (sub)title and date/author text don't
get scaled below 1rem.

Now the cover image also slides a bit under the summary / content, like
it is on landing pages.

7 years agopackage/ci: use Doxygen 1.8.14 on Travis.
Vladimír Vondruš [Mon, 1 Jan 2018 19:57:23 +0000 (20:57 +0100)]
package/ci: use Doxygen 1.8.14 on Travis.

7 years agoUpdate copyright year.
Vladimír Vondruš [Mon, 1 Jan 2018 22:48:02 +0000 (23:48 +0100)]
Update copyright year.

7 years agodoc: Doxygen 1.8.14 with all the patches was released.
Vladimír Vondruš [Mon, 1 Jan 2018 20:35:54 +0000 (21:35 +0100)]
doc: Doxygen 1.8.14 with all the patches was released.

7 years agom.dox: not just pages can have sections.
Vladimír Vondruš [Mon, 1 Jan 2018 20:22:48 +0000 (21:22 +0100)]
m.dox: not just pages can have sections.